Skip to content
The rewritten Discoin API
TypeScript Dockerfile
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github ci: update Node.js to v12.16.0 Feb 13, 2020
.vscode
src fix(transactions): zeroes check regex (#167) Feb 11, 2020
types feat(currencies): add InfluxDB support Jan 17, 2020
.dockerignore refactor: rewrite to use different DB settings Dec 27, 2019
.editorconfig style: use spaces in editorconfig for YAML files Dec 18, 2019
.env.example feat: use Sqreen Jan 5, 2020
.gitignore chore(docker-compose): start setting up Grafana and InfluxDB Jan 15, 2020
.prettierrc style: set maximum line length to 160 characters Feb 10, 2020
Dockerfile chore(docker): install cURL in server stage Jan 13, 2020
README.md docs: add section about hosting Dec 18, 2019
docker-compose.yml style: set maximum line length to 160 characters Feb 10, 2020
nest-cli.json feat: release first rewritten version Dec 16, 2019
package.json chore(deps): bump @nestjs/typeorm from 6.3.2 to 6.3.3 (#197) Feb 21, 2020
tsconfig.build.json feat: release first rewritten version Dec 16, 2019
tsconfig.json chore(tsc): use inline sourcemaps in generated files Jan 17, 2020
yarn.lock chore(deps): bump @nestjs/typeorm from 6.3.2 to 6.3.3 (#197) Feb 21, 2020

README.md

Discoin

Build Status XO code style

The new Discoin API.

Contributing

Prequisites

This project uses Node.js 12 to run.

This project uses Yarn to install dependencies, although you can use another package manager like npm or pnpm.

yarn install
# or `npm install`
# or `pnpm install`

Building

Run the build script to compile the TypeScript into the tsc_output folder. This will compile the src and the test directory, so be careful not to upload the whole folder as a published package.

Style

This project uses Prettier and XO.

You can run Prettier in the project with this command:

yarn run format

You can run XO with this command:

yarn run lint

Note that XO will also error if you have TypeScript errors, not just if your formatting is incorrect.

Linting

This project uses XO (which uses ESLint and some plugins internally) to perform static analysis on the TypeScript. It reports things like unused variables or not following code conventions.

yarn run lint

Note that XO will also error if you have incorrect formatting, not just if your TypeScript code has errors.

Hosting

This server is designed to run in a Docker environment hosted on an Ubuntu operating system (18.04).

Hosting Prequisites

Setup

  1. Setup user account

  2. Clone this repository (required for the docker-compose.yml file)

       git clone https://github.com/Discoin/rewrite.git discoin
  3. Populate the .env file

  4. Start the containers

    docker-compose -f "docker-compose.yml" up -d
You can’t perform that action at this time.