Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/quentin-piot/axum-diesel-real-world
The goal of this repository is to have a real world template of a Rust backend using Axum, Diesel, etc.
https://github.com/quentin-piot/axum-diesel-real-world
Last synced: about 2 months ago
JSON representation
The goal of this repository is to have a real world template of a Rust backend using Axum, Diesel, etc.
- Host: GitHub
- URL: https://github.com/quentin-piot/axum-diesel-real-world
- Owner: Quentin-Piot
- License: mit
- Created: 2023-09-05T15:44:02.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2023-09-15T14:44:58.000Z (over 1 year ago)
- Last Synced: 2023-09-16T07:52:43.011Z (over 1 year ago)
- Language: Rust
- Homepage: https://medium.com/@qkpiot/building-a-robust-rust-backend-with-axum-diesel-postgresql-and-ddd-from-concept-to-deployment-b25cf5c65bc8
- Size: 35.2 KB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Axum Diesel Real-World Example
[](https://github.com/Quentin-Piot/axum-diesel-real-world/stargazers)
[](https://github.com/Quentin-Piot/axum-diesel-real-world/blob/master/LICENSE)
[](https://github.com/Quentin-Piot/axum-diesel-real-world/issues)
A modular Rust backend template based on the Domain-Driven Design (DDD) architecture, utilizing the Axum and Diesel
frameworks. This repository serves as a starting point for building real-world applications in Rust, with different
modules and frameworks to choose from.
## Table of Contents
- [Introduction](#introduction)
- [Features](#features)
- [Getting Started](#getting-started)
- [Project Structure](#project-structure)
- [Available Modules](#available-modules)
- [Contributing](#contributing)
- [License](#license)
## Introduction
This repository provides a boilerplate for developing Rust backend applications following the principles of
Domain-Driven Design (DDD). It leverages the power of [Axum](https://github.com/tokio-rs/axum) for building asynchronous
APIs and [Diesel](https://github.com/diesel-rs/diesel) for working with databases.
## Features
- Domain-Driven Design (DDD) architecture.
- Integration with Axum for building asynchronous APIs.
- Integration with Diesel for database operations.
- Modular project structure for easy extension and maintainability.
- Authentication modules with OAuth (optional).
## Getting Started
Follow these steps to get started with your Rust backend project based on this template:
1. Clone this repository:
```bash
git clone https://github.com/Quentin-Piot/axum-diesel-real-world.git
```
2. Choose a specific module/framework branch or work with the default configuration.
3. Customize the project to your needs.
4. uild and run your Rust backend:
```bash
cargo run
```
## Project Structure
The project follows a modular structure to keep your code organized and maintainable. Here's a brief overview of the
project structure:
- `src/`: Contains the main source code of your application.
- `domain/`: Define your domain logic using DDD principles.
- `models/`: Define your domain models.
- `handlers/`: Define your API handlers.
- `infra/`: Define your infrastructure logic.
- `db/`: Define your database logic.
- `repositories/`: Define your repositories.
- `utils/`: Define your utility functions.
- `custom_extractors/`: Define your custom extractors for Axum.
- `main.rs`: Application entry point.
- `routes.rs`: Define your API routes.
- `config.rs`: Define your application configuration : use OnceCell for static config file.
- `error.rs`: Define your custom global error types.
- `migrations/`: Database migration files for Diesel (if applicable).
### License
This project is licensed under the MIT License.