https://github.com/duyvu997/z-seed-backend
a seed project
https://github.com/duyvu997/z-seed-backend
axum microservices postgres rabbitmq redis rust seed server tokio
Last synced: 5 months ago
JSON representation
a seed project
- Host: GitHub
- URL: https://github.com/duyvu997/z-seed-backend
- Owner: duyvu997
- License: mit
- Created: 2024-09-14T04:34:34.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-06T13:46:49.000Z (over 1 year ago)
- Last Synced: 2025-04-08T14:43:15.930Z (about 1 year ago)
- Topics: axum, microservices, postgres, rabbitmq, redis, rust, seed, server, tokio
- Language: Rust
- Homepage:
- Size: 21.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# z-seed-backend
A seed project for Rust backend development.
## Getting Started
### Prerequisites
- Rust: Install from [https://www.rust-lang.org/tools/install](https://www.rust-lang.org/tools/install)
### Installation
1. Clone the repository:
```
git clone https://github.com/your-username/z-seed-backend.git
cd z-seed-backend
```
2. Build the project:
```
cargo build
```
## Usage
Run the project:
```
cargo run
```
Run tests:
```
cargo test
```
## Development
Useful commands for development:
- Check code without building:
```
cargo check
```
- Format code:
```
cargo fmt
```
- Run the linter:
```
cargo clippy
```
## Configuration Files
### Makefile.toml
This project uses `cargo-make` for task running. See `Makefile.toml` for all available tasks.
### rustfmt.toml
The `rustfmt.toml` file in the root directory configures the Rust formatter. It sets rules for code formatting, ensuring consistency across the project. Some key settings include:
- `max_width = 100`: Maximum line width
- `tab_spaces = 4`: Use 4 spaces for indentation
- `edition = "2021"`: Use Rust 2021 edition
- `reorder_imports = true`: Automatically reorder import statements
- `reorder_modules = true`: Automatically reorder module declarations
For a full list of formatting options, refer to the [rustfmt documentation](https://rust-lang.github.io/rustfmt/).
## Contributing
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct and the process for submitting pull requests.
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.
## Acknowledgments
- List any libraries, tools, or resources you've used or been inspired by