Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tradingstrategy-ai/frontend
Web frontend for TradingStrategy.ai
https://github.com/tradingstrategy-ai/frontend
ethereum trading-algorithms trading-bot trading-platform trading-strategies
Last synced: 5 days ago
JSON representation
Web frontend for TradingStrategy.ai
- Host: GitHub
- URL: https://github.com/tradingstrategy-ai/frontend
- Owner: tradingstrategy-ai
- Created: 2021-08-31T10:05:35.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-12-21T18:27:04.000Z (20 days ago)
- Last Synced: 2024-12-29T10:08:20.449Z (12 days ago)
- Topics: ethereum, trading-algorithms, trading-bot, trading-platform, trading-strategies
- Language: Svelte
- Homepage: https://tradingstrategy.ai
- Size: 21.2 MB
- Stars: 134
- Watchers: 3
- Forks: 24
- Open Issues: 86
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://github.com/tradingstrategy-ai/frontend/actions/workflows/javascript.yml)
# Trading Strategy protocol website
A frontend for [Trading Strategy protocol](https://tradingstrategy.ai).
## Install NPM dependencies
Node >=20.11 required.
```shell
npm install
```
## Install and build submodules
`frontend` has one submodule dependency installed under `deps`:
- `fonts` - optional licensed fonts (see `static/fonts5.css` and `src/lib/components/css/typography.css`)
### Install submodules
If you have access to the private `tradingstrategy-ai/fonts`, initialize and install submodules:
```shell
git submodule update --init --recursive
```
### Building submodule dependencies
Once the submodule has been installed, a build step needs to be run in order to have a fully
working environment. Run the following script:
```shell
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](https://stackoverflow.com/questions/68479217/how-to-load-environment-variables-in-svelte).
Start the SvelteKit development server:
```shell
npm run dev
```
## Documentation
- [Testing](./docs/tests.md)
- [Running in production](./docs/docker.md)
- [Doing page speed tests](./docs/speed.md)
## Notes
### Code Formatting Standards
We are using [Prettier](https://prettier.io/) 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:
```shell
npm run format
```
Our CI/CD pipeline runs the following chack on PRs or pushes to `master`:
```shell
npm run format:check
```
### `dependencies` vs `devDependencies`
[`adapter-node` will bundle `devDependencies`](https://github.com/sveltejs/kit/tree/master/packages/adapter-node#deploying) whereas `dependencies` must be installed when deploying to production.