nodefactory/hactar-backend repository overview

⁠Hactar backend

This repository contains API implementation for Hactar, a Filecoin mining analyzer.

⁠Development

⁠Requirements

Following software is required to be installed to use this repo:

• NodeJs⁠ >= v8.4.0
• Yarn⁠
• Docker
• docker-compose

⁠Usage

Make sure to run yarn install before first build or each time you change dependencies in package.json.

On first use of this repo, run npx task build which will build docker image.You will have to run npx task build each time you change dependencies in package.json (yarn.lock).

Run npx task --help to see all available commands and their description.

⁠Notice

• make sure you update yarn.lock before building
• use sequelize-cli local to generate migrations (because of timestamp)

⁠Documentation

The documentation can be accessed on app-url:${SWAGGER_DOCS_PORT}/${SWAGGER_DOCS_URL}

• default docs url: /api/swagger
• default docs port: 8080

⁠License

This project is dual-licensed under Apache 2.0 and MIT terms:

• Apache License, Version 2.0, (LICENSE-APACHE⁠ or http://www.apache.org/licenses/LICENSE-2.0⁠)
• MIT license (LICENSE-MIT⁠ or http://opensource.org/licenses/MIT⁠)