This repository contains the source code for a fully functional backend application built with Rust, using the Axum framework. It includes user authentication, email verification, and a connection to a PostgreSQL database.
- User Authentication: Register, login, password reset functionality.
- Email Verification: Users receive an email to verify their accounts.
- PostgreSQL Integration: Store and manage user data securely.
- JWT Authentication: Secure API endpoints with JSON Web Tokens (JWT).
- Middleware: Implement custom middleware for authentication.
- Testing with Postman: A full Postman collection is provided to test all API endpoints.
To run this project, you will need:
- Rust installed on your machine.
- PostgreSQL installed and running locally or remotely.
- SQLx-CLI for database migrations.
- Postman for testing API endpoints.
-
Clone the repository:
git clone https://github.com/AarambhDevHub/rust-backend-axum.git cd rust-backend-axum -
Install dependencies:
cargo install --path . -
Set up PostgreSQL:
Create a new database in PostgreSQL and update the
.envfile with your database URL.Example:
DATABASE_URL=postgres://user:password@localhost/dbname -
Run migrations:
sqlx migrate run
-
Start the server:
cargo run
The server will be running on
http://127.0.0.1:8000.
To enable email verification, you will need to configure an email service provider. Update the following environment variables in your .env file:
SMTP_SERVER=smtp.your-email-provider.com
SMTP_PORT=587
SMTP_USER=[email protected]
SMTP_PASSWORD=your-email-passwordThe application will send verification emails to users after registration.
You can test all the API endpoints using the provided Postman collection. Download the Postman collection here and import it into Postman.
API Endpoints:
POST /api/auth/register: Register a new user
POST /api/auth/login: Login with an existing user
GET /api/auth/forgot-password: Request password reset
POST /api/auth/reset-password: Reset user password
GET /api/auth/verify: Verify email with token
GET /api/users/me: Get current user profile (JWT required)
The application requires a .env file for configuration. Below are the required environment variables:
# -----------------------------------------------------------------------------
# Database (PostgreSQL)
# -----------------------------------------------------------------------------
DATABASE_URL=postgresql://postgres:password@localhost:5432/axum_auth
# -----------------------------------------------------------------------------
# JSON Web Token Credentials
# -----------------------------------------------------------------------------
JWT_SECRET_KEY=my_ultra_secure_jwt_secret_key
JWT_MAXAGE=60
# -----------------------------------------------------------------------------
# SMTP Server Settings
# -----------------------------------------------------------------------------
SMTP_SERVER=smtp.your-email-provider.com
SMTP_PORT=587 # Common ports: 587 (TLS), 465 (SSL), 25 (non-secure)
[email protected]
SMTP_PASSWORD=your_email_password
[email protected]
Add role-based access control (RBAC) for different user roles (admin, user). Improve security with additional layers like rate limiting and input validation. Expand API to include more features like user profiles, etc.
This project is licensed under the MIT License - see the LICENSE file for details.
Axum for building powerful, fast APIs in Rust.
PostgreSQL for reliable database management.
SQLx for async SQL in Rust.
If you find this project useful and would like to support its continued development, you can make a donation via Buy Me a Coffee.
Thank you for your support!