diff --git a/README.md b/README.md index 82e5890176725b656b3ee94fe5746a63b560b9ac..61419896b59324ec47aafa84982d31de6da32d1b 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,8 @@ This is the **REST API** connecting to the [InternshipManager front end web appl Built using [node](https://nodejs.org/en/)@v16.10.0 ! +## Running the project : first method + ### Setting up NestJS If you don't already have NestJS as a global dependency, execute the following : @@ -66,6 +68,10 @@ $ npm run start:prod Any other command used to start might have *undefined behaviour* at runtime, as above commands may set environment variables required at runtime. +## Running the project : second method + +Follow the steps in readme_docker.txt in "docker" folder. Follow ONLY the "back" part steps. + ## API documentation and endpoints When running, the documentation can be found at: `{url}/api`, and specific controllers can be found at `{url}/api/{controller name}`