https://github.com/flaviodelgrosso/rust-axum-boilerplate

Rust API Server using Axum framework and MongoDB! 🦀
https://github.com/flaviodelgrosso/rust-axum-boilerplate

axum boilerplate mongodb rest-api rust server template

Last synced: about 3 hours ago
JSON representation

Rust API Server using Axum framework and MongoDB! 🦀

• Host: GitHub
• URL: https://github.com/flaviodelgrosso/rust-axum-boilerplate
• Owner: flaviodelgrosso
• License: mit
• Created: 2024-01-11T00:09:41.000Z (10 months ago)
• Default Branch: master
• Last Pushed: 2024-07-15T10:04:23.000Z (4 months ago)
• Last Synced: 2024-07-15T12:01:31.971Z (4 months ago)
• Topics: axum, boilerplate, mongodb, rest-api, rust, server, template
• Language: Rust
• Homepage:
• Size: 16.6 KB
• Stars: 5
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Rust Application Server Boilerplate using Axum framework and MongoDB! 🦀

This project is a boilerplate for building a Rust application server using the [Axum framework]("https://github.com/tokio-rs/axum") and MongoDB as the database. It provides a solid starting point for building your own Rust applications, with many common features already implemented.

## Features

- [x] Axum server: A modern and fast web framework with a focus on ergonomics and modularity.

- [x] MongoDB driver: A Rust driver for MongoDB, allowing you to interact with MongoDB collections.

- [x] Logging: Logging support using `tracing` and `tracing-subscriber` for async-compatible logging.

- [x] Error handler: Application error handling system.

- [x] Router: A router for mapping requests to handlers, cors, and static files.

- [x] Static: Static file serving using `tower-http`.

- [x] Extractors: Validation extractor for getting data from requests and validate with `validator` crate.

- [x] App config (dotenvy): Load your application's configuration from a `.env` file.

## Possible Planned Features

- Authentication: User authentication system.

- Hashing: Password hashing

- Jwt utils: Utilities for working with JWTs.

- Server Metrics

## Project Structure

The project is organized into several crates:

- `database`: Contains the MongoDB driver and user model and repository.

- `server`: Contains the main application server, including the API, router, and services.

- `utils`: Contains utility modules like config and errors.

## Getting Started

1. Clone the repository.

2. Install the Rust toolchain if you haven't already.

3. Run `cargo build` to build the project.

4. Run `cargo run` to start the server.

You can install cargo-watch to automatically recompile the project when changes are made:

```bash

cargo install cargo-watch

```

Then run `cargo watch -x run` to start the server.

## Contributing

Contributions are welcome!

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.