https://github.com/cornayy/ts-api-boilerplate
A great starting point for a TypeScript REST API using Mongoose.
https://github.com/cornayy/ts-api-boilerplate
api boilerplate mongoose rest rest-api typescript
Last synced: 2 months ago
JSON representation
A great starting point for a TypeScript REST API using Mongoose.
- Host: GitHub
- URL: https://github.com/cornayy/ts-api-boilerplate
- Owner: Cornayy
- License: mit
- Created: 2020-02-08T15:29:33.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-03-07T05:50:32.000Z (over 3 years ago)
- Last Synced: 2025-04-10T13:33:28.034Z (about 1 year ago)
- Topics: api, boilerplate, mongoose, rest, rest-api, typescript
- Language: TypeScript
- Homepage:
- Size: 1.5 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ts-api-boilerplate
## About
A great starting point for a TypeScript REST API using Mongoose.
### Included
* Seeds
* Routes
* Controllers
* Services
* Models
* Database
* Tests (Mocha, Chai, Supertest & Istanbul for Code Coverage)
* Swagger
* JWT Authentication
## Usage
```
npm install
```
### .env
Rename the `.env.example` file to `.env` and fill in the variables.
```
PORT=3000
MONGO_URI=MONGOSERVER
MONGO_DB=DATABASENAME
TOKEN_SECRET=YOURJWTSECRET
```
### Commands
Development
```
npm run dev
```
Build
```
npm run build
```
Test
```
npm test
```