Skip to content
/ api Public
forked from EddieHubCommunity/api

API to manage our community data

License

Notifications You must be signed in to change notification settings

iason9/api

 
 

Repository files navigation

api

License GitHub issues GitHub pull requests Discord GitHub forks GitHub Repo stars

Description

An API to manage our community data

Rules

  • Commits follow the standard Conventional Commit
  • Branches should be named as issue-<issue no> (e.g. NestJs issue number is 12)

Installation

$ npm install

Running the app locally

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Swagger docs

  1. start the app npm start
  2. visit http://localhost:3000/swagger

Official docs at https://docs.nestjs.com/openapi/introduction

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

Logging

Logging can be turned on by settings an environmentvariable DEBUG=true If this variables is not true or undefiend no Logs will be made.

When set to true the App will Log every incoming request.

Running the app via Docker

  1. docker run -p 3000:3000 -d ghcr.io/eddiehubcommunity/api:latest
  2. Visit http://localhost:3000/

License

MIT licensed.

MADE WITH ❤️ BY EDDIEHUBBERS ✨✨

About

API to manage our community data

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 54.1%
  • Gherkin 44.0%
  • JavaScript 1.3%
  • Other 0.6%