Bumping to v3.0, helia, synced with ipfs-service-provider

This commit is contained in:
Chris Troutner
2024-03-22 12:58:16 -07:00
24 changed files with 10771 additions and 17357 deletions
+7 -7
View File
@@ -12,8 +12,8 @@ More details are available at [CashStack.info](https://CashStack.info).
## Requirements
- node **^14.18.2**
- npm **^8.3.0**
- node **^16.20.2**
- npm **^8.19.4**
- Docker **^20.10.8**
- Docker Compose **^1.27.4**
@@ -44,7 +44,8 @@ docker-compose pull
docker-compose up -d
```
You can bring the containers back up with `docker-compose up -d`.
- You can bring the containers down with `docker-compose down`
- You can bring the containers back up with `docker-compose up -d`.
## Code Structure
@@ -55,14 +56,13 @@ The file layout of this repository differs from the koa-api-boilerplate. Instead
- `npm start` Start server on live mode
- `npm run docs` Generate API documentation
- `npm test` Run mocha tests
- `docker-compose build` Build a 'production' Docker container
- `docker-compose up` Run the docker container
## Documentation
API documentation is written inline and generated by [apidoc](http://apidocjs.com/).
API documentation is written inline and generated by [apidoc](http://apidocjs.com/). Docs can be generated with this command:
- `npm run docs`
Visit `http://localhost:5000/docs/` to view docs
Visit `http://localhost:5020/` to view docs
There is additional developer documentation in the [dev-docs directory](./dev-docs).