Skip to content

code-goodbuy/goodbuy-nodejs

Repository files navigation

GoodBuy-nodejs.

This is the repository of the GoodBuy backend for the GoodBuy project.
More information can be found here: app.code.berlin

Motivation

The current repository reflects the work done on the backend for the GoodBuy project.

Build status

Build Status Maintenance Issues Issues Issues Issues

Built with

ts nodejs express mongodb aws

..and RabbitMQ, Docker too! (can't find the badge :D)

Installation

  1. Clone the source locally:
$ git clone https://github.com/code-goodbuy/goodbuy-nodejs
$ cd goodbuy-nodejs
  1. Checkout the dev branch:
$ git checkout dev
  1. Add global ENV variables (list shared via PassCamp) - mandatory
  2. Install Node.js (will also install NPM)
  3. Install MongoDB as local DB and run it mandatory
  4. Install project dependencies:
$ npm install
  1. To compile Typescript, switch to src folder:
$ npx tsc -w -p .
  1. Run the dev branch:
$ npm run local

API Reference

You can find a complete reference to the API here: Swaggerhub

Tests

To run the tests:

$ npm run test

Credits

@5h3rr1ll - Anthony Sherrill
@Darjusch - Darjusch Schrand
@jwdotpark - Jongwoo Park
@d-pettersson - David Pettersson

Licence

MIT © GoodBuy team