From 5243ff5d325fb7e8b035b9cc34af69c1c037e700 Mon Sep 17 00:00:00 2001 From: Ayush Mukherjee Date: Mon, 7 Nov 2022 21:01:39 +0530 Subject: [PATCH] update readme --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0a8204e..6bad2f7 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,18 @@ Basic leaderboard api using next js, mariadb and typescript. +For API design, refer to `API.md`. + +## Architecture + +Nest Js is a "skeleton" MVC framework with the application being divided into modules. This project contains 3 modules namely, auth, user, and rank, for authentication, user model related, and rank model related APIs respectively. Validation of incoming data is enabled globally. + +Each module has a model service, and a controller that handles routes with some having model definitions as well. + +This project has a very basic architecure of the following: + +user ---> this api service <---> mariadb + ## Development - Copy `.env.example` to `.env`, and add relevant information @@ -14,4 +26,4 @@ Basic leaderboard api using next js, mariadb and typescript. - `pnpm run i` - `pnpm run build` - `pnpm prune --production` -- `pnpm start:prod --host 0.0.0.0` +- `node dist/main.js --host 0.0.0.0`