Rocket - Clean Architecture template

This app is crud operation with rocket rs with postgress backend

Dependency

• PostgreSQL database installed and setup
• The latest version of Rust (this porject uses v1.79.0)

Getting Started

• Using a starter template, Install cargo-generate by following their installation instructions then run the following command:

crago install cargo-generate
cargo generate --git https://github.com/gouthamsk98/rust-rocket-postgresql-template.git

DB SETUP

• install postgresql.
  • linux sudo apt install postgresql postgresql-contrib
  • macos brew install postgresql
• Start postgresql service.
  • linux sudo systemctl start postgresql.service
  • macos brew services start postgres
• we're going to run psql. We need to specify which database we're running from. Since there's a pre-created database called postgres, we're going to use that. psql -d postgres

Running locally

• Install libpq for PostgreSQL

  • linux sudo apt-get install libpq-dev
  • macos

    brew install libpq
    brew link --force libpq`
    echo 'export PATH="/opt/homebrew/opt/libpq/bin:$PATH"' >> ~/.zshrc
    source ~/.zshrc

  • windows `Who uses windows!!!"

• Install Diesel CLI for database setup cargo install diesel_cli --no-default-features --features postgres

• In the top-level project directory, run the following command with your connections details:
  echo DATABASE_URL=postgres://username:password@localhost/blog > .env
  change this to your postgress url

• Navigate into the infrastructure folder cd infrastructure and run the command diesel migration run

• Navigate back to top-level project directory and run cargo run
  

  Now You Are Ready to fly with Rocket🚀🚀🚀

Project Architecture

This Project follows the Clean Architecture model. Our architecture will follow as such that the:

• API Layer will handle the API requests and act as our route handler.
• Application layer will handle the logic behind the API requests.
• Domain layer will hold our database models and schemas.
• Infrastructure layer will hold our migrations and database connections.
• Shared layer will hold any other models our project will need such as response structures.

Folder Structure
.
├── Cargo.lock
├── Cargo.toml
├── api
│   ├── Cargo.toml
│   └── src
│       └── lib.rs
├── application
│   ├── Cargo.toml
│   └── src
│       └── lib.rs
├── domain
│   ├── Cargo.toml
│   └── src
│       └── lib.rs
├── infrastructure
│   ├── Cargo.toml
│   └── src
│       └── lib.rs
└── shared
    ├── Cargo.toml
    └── src
        └── lib.rs

Author

Goutham S Krishna