This rust-based forum server, named Discuz, is a sample project showcasing the use of Actix-web for CRUD operations, authentication, routing, pagination and more.
However, this implementation is not thoroughly tested, so please refer to the Contributing section for further instructions before use.
- Install Rust
- Install MySql if you don't have it already. You can use the docker-compose.yml file to start the MySql instance in docker.
- Clone this repo to a folder on your computer.
- Setup your database by running
cargo run --bin db-migration - Start the api server by
cargo run --bin discuz-server
The backend web service for this application is developed using Rust and the Actix framework.
A comprehensive list of crates utilized in this project can be found in Cargo.toml, however, the following are some of the key ones to note:
- Cargo Make - a task runner for Rust projects that allows developers to automate common tasks such as building, testing, and deploying their projects. It simplifies the development process by using a simple configuration file to define a set of tasks and leveraging the power of Rust's package manager, Cargo. With Cargo Make, Rust developers can streamline their workflow, making it easier to focus on writing high-quality code.
- Nextest - A testing framework for Rust projects that provides developers with a set of tools and APIs for writing and running tests for their Rust projects, making it easier to ensure the quality and reliability of their code.
This project encompasses the fundamental functionality of a forum, where both users and admins can create posts and comment within pre-defined categories. Moreover, a set of restrictions has been implemented to enhance the performance of the application and foster a fair environment for discussion.
- Limit post and comment management to only administrators, with the option for users to request deletion of their own content
- Automatically archive posts that have not received new comments in a certain period of time using a cron job.
- Improve error handling on the server API for more efficient and effective troubleshooting.
- Once the maximum limit is reached, automatically archive the post and prevent further commenting
- Implement caching for archived posts to reduce database traffic
- Implement the maximum number of comments per post
- Allow administrators to manually increase the comment limit for specific posts
- Ensure that deleting a comment does not decrease the overall comment count
- Implement a ban system to prevent banned users from commenting
This repository contains three types of tables: Entity Tables, Definition Tables, and Relation Tables.
- Entity Table
The basic unit of the program, containing essential information for various domains such as post, user, and post comment tables - Definition Table
Contains information on system configurations, typically only accessible for modification by the admin. The contents of these tables are typically loaded into the application at startup and are identified by the "def_" prefix - Relation Table
Establishes connections between entity tables and definition tables, such as the post_tag table linking the post and def_post_tag tables
The format of the foreign keys is FK-{Table name}-{Table column}-{Target table name}-{Target table column}, and index is IDX-{Table name}-{Column name}.
To execute the tests, simply run cargo nextest run or cargo test if you do not have Nextest installed. Additionally, you can use tools such as Postman or Newman by referring to the /tests directory.
I have implement the use of the tracing module for logging in place of env_logger module.
The "tracing" module offers additional functionality through the "tracing-subscriber" module, which allows us to subscribe to and manipulate log information, such as sending logs to a logging monitoring system such as Cloudwatch or DataDog.
Additionally, the five levels of logging priority, listed in ascending order of importance, are:
Trace -> Debug -> Info -> Warn -> Error
Please review the existing issues in this repository for areas that require improvement.
If you identify any missing or potential areas for improvement, feel free to open a new issue for them.
Before deploying and integrating the application, it is necessary to perform a series of validations such as testing, linting, and formatting. We recommend running cargo make pre-commit before making each commit to ensure compliance.
- Actix Examples
A list of Actix Web examples - Real world example app
Rust implementation of Real world - Rust Async-GraphQL Example: Caster Api
A sample project utilizing SeaORM as the database ORM and Axum as the server framework - Alkonost
Simple console spam detector for YouTube chats - Whatsoo
A simple opensource community - The Rust Programming Language
The Git book about Rust from MIT