https://github.com/developer239/node-typescript-api

NodeJs meets typescript.
https://github.com/developer239/node-typescript-api

Last synced: 11 months ago
JSON representation

NodeJs meets typescript.

• Host: GitHub
• URL: https://github.com/developer239/node-typescript-api
• Owner: developer239
• Created: 2019-01-21T17:25:19.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2019-11-03T14:13:28.000Z (about 6 years ago)
• Last Synced: 2025-01-04T21:41:47.393Z (about 1 year ago)
• Language: TypeScript
• Homepage:
• Size: 4.53 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 35
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
[![CircleCI](https://circleci.com/gh/developer239/node-typescript-api.svg?style=svg)](https://circleci.com/gh/developer239/node-typescript-api)

[![Maintainability](https://api.codeclimate.com/v1/badges/5ec1c93577d041551baf/maintainability)](https://codeclimate.com/github/developer239/node-typescript-api/maintainability)

[![Test Coverage](https://api.codeclimate.com/v1/badges/5ec1c93577d041551baf/test_coverage)](https://codeclimate.com/github/developer239/node-typescript-api/test_coverage)

[![Greenkeeper badge](https://badges.greenkeeper.io/developer239/node-typescript-api.svg?token=76d75cc9efd4f1141c5df424f2a8d016654313d2766e2704b0985a28a794002b&ts=1548104970009)](https://greenkeeper.io/)

[![TypeScript](https://badges.frapsoft.com/typescript/version/typescript-next.svg?v=101)](https://www.typescriptlang.org/)

# Node Typescript API

Demo application [is running here](https://node-typescript-api.herokuapp.com/) (it might take a while before the free server wakes up)

📘 API is documented [here](https://node-typescript-api.herokuapp.com/docs).

📗 Example frontend application is [here](https://github.com/developer239/node-typescript-react-web).

## Development

System Dependencies:

1. `brew install node`

2. `brew install yarn`

3. `brew install make`

3. `brew install docker`

4. `brew install docker-compose`

Run docker database:

1. `make infra`

2. `make db-migrate`

3. `make db-seed`

Run node server:

1. `make node_modules`

2. `make watch`

Define `env` variables:

1. `cp .env.development.template .env.development`

2. If you want to have password reset working then you must set `EMAIL_TOKEN` variable. You can find more information on [sendgrid.com](https://sendgrid.com/)

Now you can open [http://localhost:8080](http://localhost:8080) in your browser.

### Helpful Commands

- `make db-migrate`     apply database migration

- `make db-rollback`    rollback database migration

- `make db-reset`       rollback and migrate

- `make db-seed`        seed database

- `make test`           run tests

- `make test-coverage`  run tests and report coverage