An open API service indexing awesome lists of open source software.

https://github.com/zzh8829/egg-typescript-passport-rest-api

eggjs typescript passport rest api
https://github.com/zzh8829/egg-typescript-passport-rest-api

egg eggjs jwt passport rest-api typescript

Last synced: 7 months ago
JSON representation

eggjs typescript passport rest api

Awesome Lists containing this project

README

          

# EGG Typescript Passport Rest API

## Overview

- eggjs and typescript
- login with username/password + github
- api protected by JWT
- postgres db

## QuickStart

### Development

```bash
$ npm i
$ npm run dev
$ open http://localhost:7001/
```

Don't tsc compile at development mode, if you had run `tsc` then you need to `npm run clean` before `npm run dev`.

### Deploy

```bash
$ npm run tsc
$ npm start
```

### Npm Scripts

- Use `npm run lint` to check code style
- Use `npm test` to run unit test
- se `npm run clean` to clean compiled js at development mode once

### Requirement

- Node.js 8.x
- Typescript 2.8+