EOSIO Backend Boilerplate

A highly scalable skeleton with best practices, ideal for backend projects quick start.

Features!

This boilerplate features all the latest tools and practices in the industry

• hasura Hasura GraphQL Engine is an opensource service that connects to your databases & microservices and auto-generates a production-ready GraphQL backend

• hapi A back end service for custom busines logic integrated with hasura using actions

• docker-compose Compose is a tool for defining and running multi-container Docker applications

File Structure

Within the download you'll find the following directories and files:

eoscrbackendboilerplate/
├── hasura
│ ├── migrations
│ └── config.yaml
├── hapi
│ ├── src
│ | ├── config
│ | ├── api
│ | ├── routes
│ | └── config.yaml
│ ├── .dockerignore
│ ├── .eslintrc
│ ├── .prettierrc
│ ├── Dockerfile
│ ├── yarn-lock.json
│ └── package.json
├── .env.example
├── .gitignore
├── docker-compose.yaml
├── .LICENSE
├── .prettierrc
├── Dockerfile
├── LICENSE
└── README.md

There are some important folders like

• hapi/src/api should have all reusable code for example a code to generate tax invoice
• hapi/src/routes this folder should only have the endpoint mapping and params validations and use functions from api folder to handle the business logic

Installation

Basic knowledge about Docker, Docker Compose and NodeJS is required.

Getting started

Some things you need before getting started:

• git
• node.js
• docker
• docker-compose
• Hasura CLI

Running for the first time

1. Clone this repo using git clone --depth=1 https://github.com/eoscostarica/backend-boilerplate.git <YOUR_PROJECT_NAME>
2. Move to the appropriate directory: cd <YOUR_PROJECT_NAME>.
3. Copy the .env.example then update the environment variables according to your needs

Quick start

At this point you can execute make run, you can check the services runing on:

• hapi at http://localhost:9090
• hasura at http://localhost:9695

Contributing

Please Read EOS Costa Rica's Open Source Contributing Guidelines.

Please report bugs big and small by opening an issue

About EOS Costa Rica

EOS Costa Rica is an independently-owned, self-funded, bare-metal Genesis block producer that provides stable and secure infrastructure for the EOS mainnet. We support open source software for our community while offering enterprise solutions and custom smart contract development for our clients.