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: 10 days 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 (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-02-01T18:27:51.000Z (almost 2 years ago)
• Last Synced: 2023-03-03T08:11:13.373Z (over 1 year ago)
• Topics: api, boilerplate, mongoose, rest, rest-api, typescript
• Language: TypeScript
• Homepage:
• Size: 1.42 MB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 3
• 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

```