mpurdon / frontend

Web frontend for TradingStrategy.ai

Trading Strategy protocol website

A frontend for Trading Strategy protocol.

Install NPM dependencies

Node v16+ required.

npm install

Install submodules

frontend has several submodule dependencies installed under deps, including:

• theme - Bootstrap v4 theme (being phased out)
• trade-executor-frontend - frontend to trade-executor (beta UI for active trading strategies)
• fonts - optional licensed fonts used by theme and our new design-system

Install all submodules (inclduing private fonts)

If you have access to the private tradingstrategy-ai/fonts, initialize and install all submodules:

git submodule update --init --recursive

Install only public submodules

If you don't have access to fonts, install only the public submodules:

git submodule update --init --recursive -- deps/theme deps/trade-executor-frontend

Building submodule dependencies

Once the submodules have been installed, their own install/build steps need to be run in order to have a fully working environment. The following script runs npm build on submodules and generates old Bootstrap v4 theme bundle:

bash scripts/build-deps.sh

Running in local dev

Environment variables required by the app are maintained in a .env file. Read about about magic VITE envs.

Start the SvelteKit development server:

npm run dev

Documentation

• How to develop and integrate the Bootstrap theme
• Testing
• Running in production
• Doing page speed tests

Notes

Code Formatting Standards

We are using Prettier for code formatting. Extensions are available for most code editors / IDEs (see "Editor Support" on Prettier homepage).

If you prefer not to have your editor do automatic formatting, please run the following command and commit properly formatted code before pushing a PR:

npm run format

Our CI/CD pipeline runs the following chack on PRs or pushes to master:

npm run format:check

SvelteKit and Svelte component installation issue

Any external Svelte components need to be installed as development dependency because of SSR.