TradeNote

Appearance

Installation Guide ​

Docker Compose ​

This is the recommended way of installing TradeNote and will get you quickly up and running.

Requirements ​

  • Docker
  • Docker Compose

Installation ​

  1. Download the docker compose.yml file to the desired folder on your server.
  2. Run docker compose up -d.

This will automatically setup the database (mongodDB) and the TradeNote app.

You can then access the website on http://localhost:8080.

If you cannot access the website, please refer to the Troubleshooting page or get support via Discord

Docker ​

Requirements ​

  • Docker
  • MongoDB

Installation ​

You need to have a running MongoDB database. Please see their Docker Hub for instructions.

Then, run the TradeNote image with its environment variables.

docker run \
    -e MONGO_URI=<mongo_uri> \
    -e TRADENOTE_DATABASE=<tradenote_database>
    -e APP_ID=<app_id> \
    -e MASTER_KEY=<master_key> \
    -e TRADENOTE_PORT=<tradenote_port> \
    -p <tradenote_port>:<tradenote_port> \
    --name tradenote_app \
    -d eleventrading/tradenote
  • MONGO_URI: The MongoDB connection string, with tradenote database name and enforced access control (explanation). You can use any MongoDB instance you like. If you are using Docker, you can use the default MongoDB instance. (example: mongodb://tradenote:tradenote@mongo:27017/tradenote?authSource=admin)
  • TRADENOTE_DATABASE: The TradeNote database name in the MongoDB (example: tradenote)
  • APP_ID: Set a random string as application ID, which will be used to connect to the backend (no spaces) (example: 12345).
  • MASTER_KEY: Set a random string as master key, which will be used to make root connections to the backend (no spaces) (example: 12345)
  • TRADENOTE_PORT: TradeNote port number, from which you wish to serve the website. (example: 8080)

Building Locally ​

You can also build TradeNote yoursel, either by building the docker image locally or by building the project in devevelopement or production mode

Docker ​

  1. Clone from github
  2. cd into TradeNote directory
  3. Run
    • For Docker Compose : Run docker compose -f docker compose-local.yml up -d
    • For Docker: run docker build -f docker/Dockerfile . -t tradenote:<tag>

Development Mode ​

  1. Clone the project (Master or Beta branch)
  2. cd into your project
  3. Run npm install
  4. Run APP_ID=xxx MASTER_KEY=xxx MONGO_USER=xxx MONGO_PASSWORD=xxx TRADENOTE_DATABASE=xxx MONGO_URL=xxx MONGO_PORT=xxx TRADENOTE_PORT=xxx NODE_ENV='dev' node index.mjs

Production Mode ​

  1. Clone the project (Master or Beta branch)
  2. cd into your project
  3. Run npm install
  4. Run npm run build
  5. Run APP_ID=xxx MASTER_KEY=xxx MONGO_USER=xxx MONGO_PASSWORD=xxx TRADENOTE_DATABASE=xxx MONGO_URL=xxx MONGO_PORT=xxx TRADENOTE_PORT=xxx node index.mjs