Shinigami92 / star-citizen-trade-market-api

Star Citizen Trade Market Backend API

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Star Citizen Trade Market - API

Star Citizen Logo

A progressive Node.js API for Star Citizen to track the market with the help of the community.

Frontend

Discord

Discord Chat

Why dont you use VerseMate?

I really like VerseMate! However, there are a few things that VerseMate (currently) does not support

This API and the associated frontend has the following advantages:

  • Community-based the data is not read from the game
  • API frontend is completely decoupled from the API
  • Open Source everyone can contribute
  • You can provide item prices to your main organization or make them available to all your organizations

Installation

$ yarn

Init database

$ yarn migrate up

Running the app

# development
$ yarn start

# watch mode
$ yarn start:dev

# incremental rebuild (webpack)
$ yarn webpack
$ yarn start:hmr

# production mode
$ yarn start:prod

Test

# unit tests
$ yarn test

# e2e tests
$ yarn test:e2e

# test coverage
$ yarn test:cov

Local setup with docker

$ docker network create sctm-net
$ docker-compose up

Now you can connect into the database via pgadmin localhost:5433 Also you can fetch the api via localhost:3000/graphql

Docker Cleanup

$ docker rm SCTM_API
$ docker rmi star-citizen-trade-market-api_sctm-api
$ docker rm SCTM_PostgreSQL

License

MIT licensed

About

Star Citizen Trade Market Backend API

License:MIT License


Languages

Language:TypeScript 97.3%Language:JavaScript 2.4%Language:Dockerfile 0.3%Language:Shell 0.1%