Skip to content
This repository has been archived by the owner on May 14, 2021. It is now read-only.

Latest commit

 

History

History
100 lines (79 loc) · 2.73 KB

README.md

File metadata and controls

100 lines (79 loc) · 2.73 KB
Raw

Kin Ecosystem Marketplace Server

Disclaimer

Any data that appears in the repo does not reflect real partnerships or product integrations. We use real company names and products for the sole sake of mocking data to populate our SDK client.

Documentation

Install/Run

Clone this repo, and then in a terminal:

marketplace-server> npm i
marketplace-server> npm run restart

Development

Please make sure that you follow the code conventions which are described/enforced by the IDE and tslint.
In any jetbrains based IDE (webstorm, pycharm, intellij, etc):

  • Code style

    1. Go to the Preferences > Editor > Code Style
    2. Click the small gears icon besides the Scheme drop down box
    3. Import Scheme > IntelliJ IDEA code style XML
    4. Select the code_style_scheme.xml file in the root of this project.

  • TSLint

    1. Go to Preferences > Languages & Frameworks > TypeScript > TSLint
    2. Check the Enable box
    3. Make sure that the Search for tslint.json options is selected under Configuration file.

Testing

First compile the source:

make build

then create the DB:

make db

Then run the tests:

make test

Running in Docker

To run and test using docker follow the instructions bellow:

Setup

Download docker + docker-compose for your environment.

If you DON'T have a wallet with XLM and KIN: Run the following command to generate a secrets/.secrets file with a pre-funded wallet:

make generate-funding-address

Note that this command will overwrite any existing file secrets/.secrets.

If you have a wallet with XLM and KIN: You need to have a stellar account with funds and create a secrets/.secrets file locally with the following content:

export STELLAR_BASE_SEED=SXXX
export STELLAR_ADDRESS=GXXX
Create JWT encryption keys
make create-jwt-keys:

will create the dir jwt/ with random encryption keys. You can add other keys if you'd like. the keys in the public_keys dir will be exported via /v1/config call.

Run docker servers and system tests

Run the following command:

make up  # start all services

And in a separate shell:

make test-system-docker  # run tests

To stop the services

make down

Run with mounted code for development

You will need to install the dependencies and build the code locally using:

make install build

Then when you want to run your local version, instead of make up, run:

make up-dev