README.md

Welcome to Helpbuttons' backend Repository

This is the backend repository for Helpbuttons. In order to comunicate with this backend (API) you need to install hb-front too. For more detailed info check the hb-docs repo (https://github.com/helpbuttons/hb-docs).

This software is currently being developed heavily, so be minded this might not work, but you are welcome to contribute

Getting Started

First, setup the .env file:

$ cp .env.sample .env

edit the .env file according to your needs.

Secondly, run the postgis server using docker:

$ docker-compose up -d db

run the backend:

$ yarn

$ yarn dev

run the migrations:

$ yarn migration:run

Open http://localhost:3001 with your browser to see the result.

You can checkout the documentation of the api at http://localhost:3001/doc/

Using pre-created data

You can use the pre-created data:

yarn seed:run

login: [email protected] password: password

deploy

! don't forget to edit the .env file!

$ docker-compose up -d

Main tech specifications used in this repo:

Typescript, NestJS, TypeORM

Learn More

This is a nestjs

To learn more about nestjs, take a look at the following resources:

• Nestjs Documentation - learn about nestjs features.

You can check out the nestjs GitHub repository - your feedback and contributions are welcome!

Troubleshooting

• Accessing the database to docker:

$ docker-compose exec db psql -U [USER] [DATABASE_NAME]

• When the backend fails to start because of database problems, you can always reset the database, by removing the directory db

• If you need to drop the scheme and restart fresh you run $ yarn schema:drop