For developers, open CONTRIBUTING.md

¡Build your own collaboration app in seconds with Helpbuttons!

This software helps you to build collaborative tools for any activity, such as sharing transport or seizing food. It connects people with specific needs to create networks. Mutual support groups, neighborhood communities, schools, town halls or emergency teams would be great benefit from it.

We're currently testing real life examples that you can check in our website. Specially we're aiming to maximize accesibility and develop modules that allow more use cases. Check those tags if you want to help us in those fields.

You can install your own tool in your server with this repo or ask us for help and host it at helputtons.org

We accept donations:

USD/EUR

BTC

Mastodon

contact us: help at helpbuttons.org

Welcome to Helpbuttons Repository

This is the repository for helpbuttons.org. check more documentations at the repo (https://github.com/helpbuttons/hb-docs).

Getting Started

Using docker

copy the env.sample file: $ cp env.sample .env

edit the .env file according to your needs

generate jwt token:

$ docker-compose run api yarn cli config:genjwt

add the jwtSecret generated to the .env file

lets put it all up

$ docker-compose up

Open the browser on http://host:3000

run all the migrations / setup the database schema:

$ docker-compose run api yarn migration:run

Upgrade

$ docker-compose pull

$ docker-compose run api yarn migration:run

Main tech specifications used in this repo:

Typescript, React, NextJS, Leaflet, CSS, HTML

This is a Next.js project bootstrapped with create-next-app.

To learn more about Next.js, take a look at the following resources:

• Next.js Documentation - learn about Next.js features and API.
• Learn Next.js - an interactive Next.js tutorial.

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Main tech specifications used in this repo:

Typescript, NestJS, TypeORM

This is a nestjs project

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

• Nestjs Documentation - learn about nestjs features.

• checkout the list of available icons from react-icons You can check out the nestjs GitHub repository - your feedback and contributions are welcome!

Troubleshooting the api

• 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 or $ docker-compose exec api yarn schema:drop