https://github.com/xilution/todd-coin-api

https://github.com/xilution/todd-coin-api

Last synced: about 9 hours ago
JSON representation

• Host: GitHub
• URL: https://github.com/xilution/todd-coin-api
• Owner: xilution
• License: mit
• Created: 2022-04-10T23:27:39.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-06-09T13:27:15.000Z (over 2 years ago)
• Last Synced: 2024-04-17T16:12:45.876Z (7 months ago)
• Language: TypeScript
• Size: 707 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# todd-coin-api

Todd Coin is a Cryptocurrency for Good.

This is the Todd Coin Application Programming Interface (API)

The Todd Coin API adheres to the [JSON API](https://jsonapi.org/format/) standard.

# Releases

The Todd Coin API is distributed as a Docker container.

[![Release](https://github.com/xilution/todd-coin-api/actions/workflows/release.yml/badge.svg)](https://github.com/xilution/todd-coin-api/actions/workflows/release.yml)

https://hub.docker.com/r/xilution/todd-coin-api

# Development

## First Things First

`npm install`

## To Build the Docker Image

`npm run docker-build`

## To Start the Database and API

`npm run docker-compose-up`

## To Initialize the Database

This is a one time task

`npm run init-db`

## To Stop the Database and API

`npm run docker-compose-down`

## To View Database and Node Logs

`npm run docker-compose-logs`

## To Delete the Database Data

`rm -rf ~/.todd-coin/pg-data`