Frontend code repo can be found HERE
This repo is for the DED backend repository.
The main language of the backend is Rust. The choosen web framework for this language is actix-web framework. The library for database interaction is performed by diesel.
- Rust - stable
- Current version of stable (at time of writing) is
1.41.1 - the cargo executable.
- Current version of stable (at time of writing) is
- this repo!
- Option 1: Homebrew
If you have have homebrew installed, you can install Rust with the following command:
brew install rust
This will give you the current stable version
- Option 2: Rustup
If you don't have homebrew installed, another option is to use the rustup command to help keep your installation of rust organzied. To install rustup use this command:
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
After rustup is installed, you need to configure it to use the stable version, run the following commands to do so:
rustup toolchain install stable
rustup default stable
- Option 1: Local package manager
Please search for and install the stable version of rust used by your package manager. If for some reason the version provided by your distro is less than the stable version above, please use the second option.
- Option 2: Rustup
Please follow the OSX: Option 2 instructions above.
Start by installing Postgres. On MacOS, this can be done using homebrew by running brew install postgresql. For other platforms, Postgres has detailed guides available here.
Once you have installed Postgres, you need to start the Postgres server. To have the server start on login for MacOS, you can use the command brew services start postgresql.
Now, create a file in the root directory of the project called .env. This stores environment variables used by Rust. In this file, create the following line, replacing <Username> with your user account name:
DATABASE_URL=postgres://<Username>:@localhost/build_db
Next, we need to install Diesel. This can be achieved by running:
cargo install diesel_cli --no-default-features --features postgres
Finally, run diesel migration run to have diesel automatically generate the database and tables for you.
If for any reason you would like to reset the database back to its original, empty state, this can be done using diesel migration redo.
After making sure that rust and cargo are installed, using the following command from the top of the repo:
cargo build
After making sure that rust and cargo are installed, using the following command from the top of the repo:
cargo run
after cargo rebuilds the code, there should now be a service running on your localhost
After making your changes, you can run the test by using this command:
cargo test
Cargo can automatically build the documentation for you to view and use. The best command to do this is:
cargo doc --open
After the documentation for this project and all of its dependencies has been created, the machine's default web browser will open up to the local documentation for this project.