Traders

Rust

The recommended way of installing Rust is through rustup

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

PostgreSQL

The project is using PostgreSQL. You can install PostgreSQL for whatever machine you are using.

There is a docker script for starting a PostgreSQL database.

Use this command to connect to the PostgreSQL docker container.

psql -h 127.0.0.1 -p 5432 -U postgres

Sometimes we may need to rebuild the database while developing

Redis

Redis is required for some features like keeping user sessions. You can also install Redis for whatever machine you are using.

sqlx

I use sqlx-cli to manage the database. The following command will install for only postgres

cargo install sqlx-cli --no-default-features --features native-tls,postgres

We can initialize the database using

sqlx database setup

Add a migration using sqlx

sqlx migrate add <migration_name>

Run the migrations with

sqlx migrate run

Revert the last migration with

sqlx migrate revert

Why queries fail to compile

When deploying to server

Remember to get a copy of the configuration/local.yaml, configuration/base.yaml, and configuration/production.yaml.

base_url needs to be set in the configuration/production.yaml. This can be set to the domain the project will be hosted on.

Create a systemd service to run the application.

The systemd service loads environment variables using a path. Be sure to restrict reading access to this file in order to protect secrets

Development

For autocompiling on code changes install cargo-watch with: cargo install cargo-watch

Then run cargo watch -x run

Frontend

Instead of using a frontend framework, this project will use SSR to serve HTML, SCSS, and JavaScript.

Compile the .scss files using the npm run build:scss command. (Located under scripts: in package.json)

To get scss to autocompile during developent, install: npm install nodemon --save-dev

After installing, run npm run watch:scss

The project uses tera for templating.

Future feature: [ ] Add Stimulus/Turbo with Hotwire

Javascript

Add javascript files to /static/js/ directory and include them in the html wherever they are needed

Routes and returning from them

For simple routes it is fine to return with something simple like fn simple_endpoint() -> HttpResponse {}

For other routes, we can return a Result: fn other_route() -> Result<HttpResponse, actix_web::Error> {}

• Actix-web will automatically convert actix_web::Errors into an HttpResponse
• We can create an error enum to convert errors and implement the actix_web::ResponseError trait to define our own HttpResponse for errors

Tests

Run tests with the command cargo test

If you want to run a certain test, you can specify the name of the test.

• Ex: cargo test authorized_user_creation will run tests that match authorized_user_creation

If you want to capture println!() statements, add -- --nocapture to the command.

• Ex: cargo test -- --nocapture

TODO

• Bring database changes from other repository and get at least homepage to show
• Set up server to display homepage
• Set up CI/CD
  • Set up a master branch for production and a development branch for development. Work off of development branch
  • Set up so master branch deploys to server whenever it is pushed to
• Set up separate repository with a minimal production ready app with user login and a homepage
• Fix the test suite
  • Routes:
    • HealthCheck
    • Users
  • Models:
    • Users
  • Domain:
    • Username
    • Email
• Implement remainder of routes (Write tests simultaneously and remove all hardcoded strings)
  • User
  • Account
  • Trade
  • Execution
  • JournalEntry
  • Tag
• Look into some best practice for database management
  • Make a cron job to do nightly pg_dumps for database backups and upload to some cloud server

Current State

I am currently working to stabilize the development experience and infrastructure.

The plan to achieve this is:

1. Get the app in a minimal working state (have health_check and homepage showing)
2. Set up CI/CD, and then write tests.

• Start with tests for applicaiton setup files, health_check endpoint, and users endpoints
  • There is a lot of outdated code in the users routes. (the file also needs to be renamed to src/routes/users
  • Write documentaiton along the way

4. Copy this point of the project to a new repository

• This will make starting a new project with actix-web a breeze as there will be a great starting point

1. New features should be developed off of the development branch.
2. Merging to master will trigger deployment to production environment.

Testing

If an error like this appears failed to find data for query INSERT INTO users (id, email, username, password_hash)

• run this command DATABASE_URL=postgres://your_database_url cargo sqlx prepare

Errors saying there are too many files open could be fixed for the current shell session with ulimit -n 50000

Purpose

NinjaTrader is a futures trading platform that provides users with an excel file (.xlsx) of every trade execution they make during that trading day.

This project provides a way for futures traders to easily keep track of all their trades and provide visual feedback of how much money they are losing.

Excel file uploads are watched using the ./traders-watch.sh script, which are then parsed into trades using the ./trademaker executable.

These trades are saved using a PostgreSQL database and served through an API using the Actix Web web framework.