https://github.com/souravinsights/nest-api-starter
Nest API starter kit for people getting started with Nest.js
https://github.com/souravinsights/nest-api-starter
mongodb nestjs nodejs-api rest-api
Last synced: about 1 month ago
JSON representation
Nest API starter kit for people getting started with Nest.js
- Host: GitHub
- URL: https://github.com/souravinsights/nest-api-starter
- Owner: SouravInsights
- Created: 2020-08-04T13:11:39.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-03-08T03:24:11.000Z (about 3 years ago)
- Last Synced: 2025-08-25T17:44:59.825Z (9 months ago)
- Topics: mongodb, nestjs, nodejs-api, rest-api
- Language: TypeScript
- Homepage:
- Size: 267 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# nest-api-starter - a starter api built using nest.js
This tiny repo is a starter kit for people getting started with [Nest.js](https://nestjs.com/).
> Hope it gives you a practical walkthrough of some of the concepts of Nest.js.
## Built using
- [Nest.js](https://nestjs.com/)
- [MongoDB](https://www.mongodb.com/)
- [Mongoose](https://mongoosejs.com/)
- [Typescript](https://www.typescriptlang.org/)
## How to setup
### Project setup
- `git clone https://github.com/SouravInsights/nest-api-starter.git`
- `cd nest-api-starter`
- `yarn install`
- `yarn dev`
### DB setup
- **MongoDB installation**
- install [Mongodb Community Server](https://www.mongodb.com/try/download/community?tck=docs_server) and refer to [how to download and setup mongodb](https://docs.mongodb.com/manual/tutorial/install-mongodb-on-windows/) guide for more information.
- **Local setup**
- create data/db directory in any of your drive where mongodb will store all the data
- `cd F:\`
- `md "\data\db"`
- run `mongod --dbpath "F:/data/db"` to start mongodb
- **Create your database**
- run `use nest-api-db` which will craete your database, if the database doesn’t exist already
- **MongoDB Compass installation**
- you can also [install mongodb compass](https://docs.mongodb.com/compass/master/install) as the gui for mongodb
- open mongodb compass, connect to your local mongodb server and create your database from the gui
## Project structure
(to be added)