lgtm-migrator / backend-1

Welcome to Komak’s open-source repository 🙏

What is Komak?

Komak is an app born out of necessity in the wake of the COVID-19 events. There are people in our community more susceptible or already exposed to the effects of the virus than others. The goal of Komak is to provide a digital platform for healthy volunteers to help out those most in need.

Komak uses geolocation services to send requests for help with groceries, for example, to nearby volunteers that are willing to help out.

Komak is meant to be open-source, as we need all of the help we can get in this hopefully short-lived endeavor.

Description

This repo is the backend for Komak project (https://github.com/komakio).

Technologies implemented:

• NestJs-typescript
• mongoDB
• RabbitMQ
• Jest
• Swagger
• Docker

Prerequisites

• Node.js (>= 10.8.0)
• npm (>= 6.5.0)

Installation

$ npm install

Running the app

# containers
$ docker-compose up -d

# watch mode on port 3100
$ npm run start:dev

# queue jobs
$ npm run dev:jobs

Test

# e2e tests
$ npm run test

Other commands

# formatting code
$ npm run format

# run linter
$ npm run lint

# run typescript compiler
$ npm run tsc

Swagger API docs

This project uses the Nest swagger module for API documentation. NestJS Swagger - www.swagger.io
Swagger docs will be available at localhost:3100/docs

We can use all the help we can get. Please send an email and any relevant work you’ve done to [email protected]. Join our open Slack community.