#Documentation

The PROJECT API is the API of PROJECT API

Author 🚀

@SofwanCoder

---

Technologies

• Rust
• Actix-Web

---

Database

• MongoDB
• PostgreSQL
• Redis
• RabbitMQ

---

Install Rust

To Install Rust, go to RustLang and follow the necessary instructions required depending on your PC Operating System

---

Install Cargo

To Install Cargo, go to Cargo and follow the necessary instructions required depending on your PC Operating System

---

The Env File

Copy the .env.sample file and rename it to .env and update the values accordingly

---

Setup Database

To set up your database for the project, after creation kindly open the .env file and update as necessary

POSTGRES_URI=
REDIS_URI=
MONGO_URI=
AMPQ_URI=

---

Development

Use this template https://github.com/SofwanCoder/rust_project_api

Dev Dependency

To install the dev dependencies needed to monitor and continuously watch for changes, kindly run

cargo install cargo-watch

Installation

To install the necessary packages, in your folder directory kindly run

cargo build

• To continuously watch for changes

  • cargo watch -c -w src -x run

• To run test cases

  • cargo test

• To build your app (for production append --release to the command)

  • cargo build

• To run your app server (for production append --release to the command)

  • cargo run

• To validate without building

  • cargo check