<palign="center">A progressive <ahref="http://nodejs.org"target="_blank">Node.js</a> framework for building efficient and scalable server-side applications.</p>
<ahref="https://opencollective.com/nest#backer"target="_blank"><imgsrc="https://opencollective.com/nest/backers/badge.svg"alt="Backers on Open Collective"/></a>
<ahref="https://opencollective.com/nest#sponsor"target="_blank"><imgsrc="https://opencollective.com/nest/sponsors/badge.svg"alt="Sponsors on Open Collective"/></a>
<!--[](https://opencollective.com/nest#backer)
[](https://opencollective.com/nest#sponsor)-->
## Description
**IntershipManager** - The whole lifecycle of internship agreements in one app !
This is the **REST API** connecting to the InternshipManager front end application to manage **CRUD** operations.
This is the **REST API** connecting to the InternshipManager front end application to manage **CRUD** operations.
## Installation
## Installation
Built using [node](https://nodejs.org/en/)@v16.10.0 !
### Setting up dependencies
Use npm to download all the dependencies :
```bash
```bash
$ npm install
$ npm install
```
```
### Setting up your config file
In `/src/config/`, make a copy of the file `config.template.json` and rename it to `config.json`.
In `/src/config/`, make a copy of the file `config.template.json` and rename it to `config.json`.
Set the following field :
Set the following field :
```json
```json
"server":{
"server":{
"port":3001
"port":3001
},
},
```
```
You may replace `3001` by any port you wish to run the application on.
### Initiating the database
This is the port the server will run on.
You may replace `3001` by any port you wish to run the server on.
This server uses [Mongodb](https://www.mongodb.com/) for persistent data storage. To initiate the database, you must have an instance of mongo running. You may use the dockerfile located in `docker/` at the root of the project and run the command `docker-compose up -d` to create and run a mongo instance as a background task.
### Setting up the database
This server uses [Mongodb](https://www.mongodb.com/) for persistent data storage. To initiate the database, you must have an instance of mongo running. You may use the dockerfile located in `docker/` at the root of the project and run the command `docker-compose up -d` to create and run a mongo instance as a background task (get [Docker](https://www.docker.com/)).
In the `src/config/config.json`, set the following field :
In the `src/config/config.json`, set the following field :
In the event you wish to run mongo on another port or use another collection, make sure to update the **uri** in the config file.
In the event you wish to run mongo on another port or use another collection, make sure to update the **uri** in the config file.
## Running the app
## Running the app
For development purposes, we use :
```bash
$ nest start --watch
```
But you may use, according to what you need :
```bash
```bash
# development
# development
$ npm run start
$ npm run start
...
@@ -67,16 +63,4 @@ $ npm run start:dev
...
@@ -67,16 +63,4 @@ $ npm run start:dev
$ npm run start:prod
$ npm run start:prod
```
```
## Support
Check the [license](LICENSE).
Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support).
