Skip to content
Snippets Groups Projects
Unverified Commit 7a8395f4 authored by Kemal's avatar Kemal Committed by GitHub
Browse files

Merge pull request #24 from ivanalglave/README_update

Update README.md
parents 15dfdef8 72bf4155
Branches master
No related tags found
No related merge requests found
......@@ -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}`
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment