README.md

template-api-nodejs

Initial files for API in TypeScript, using NestJS and MongoDB

Start

Clone repository in the folder you want

git init
git clone https://github.com/Joao-CruzA/API-TypeScript.git

Make the necessary installations

yarn

or

npm install

Then just run the command to start the dev environment. He had started running on port 3000 (https://localhost:3000/api/start)

yarn dev

Or the command to build the code

yarn build

Don't forget to make the recommended settings first. (Right below)

Configuration

In the package.json file, change the name and description of your project (Remembering that the database will use the name of the project, for example project_name.back, the db will be called "project_name")

"name": "project_name.back",
"version": "0.0.1",
"description": "Api project_name",
...

Don't forget to also change the project name in the BaseController file in the src/Api/Controllers/public/Base folder

Credits and Technologies

• NestJS
• NodeJS
• WebPack
• MongoDB
• TypeScript

License

MIT