https://github.com/nodefactoryio/hactar-backend
Node.js backend application for Hactar (Filecoin tool for mining analysis)
https://github.com/nodefactoryio/hactar-backend
api filecoin filecoin-lotus filecoinminer statistics
Last synced: about 1 month ago
JSON representation
Node.js backend application for Hactar (Filecoin tool for mining analysis)
- Host: GitHub
- URL: https://github.com/nodefactoryio/hactar-backend
- Owner: NodeFactoryIo
- License: mit
- Created: 2019-12-18T10:40:53.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-24T00:58:59.000Z (over 3 years ago)
- Last Synced: 2025-02-27T00:56:00.312Z (over 1 year ago)
- Topics: api, filecoin, filecoin-lotus, filecoinminer, statistics
- Language: TypeScript
- Size: 2.23 MB
- Stars: 1
- Watchers: 4
- Forks: 2
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# Hactar backend
> Node.js application for Hactar API.
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](https://nodejs.org/en/) >= v8.4.0
* [Yarn](https://yarnpkg.com/en/docs/install#debian-stable)
* 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}`
> e.g. _http://localhost:8080/api/swagger/_
- 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](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
