Mirrors/Axum-Rust-Rest-Api-Template
2
0
Fork 0
mirror of https://github.com/thanipro/Axum-Rust-Rest-Api-Template synced 2024-11-10 06:04:16 +00:00
Code Issues Projects Releases Packages Wiki Activity
No description
11 commits 1 branch 0 tags 73 KiB
Rust 100%
Find a file
Thani Sheun 0c342b3484 group use statement, fix user sql
2023-05-04 17:03:49 +02:00
migrations group use statement, fix user sql 2023-05-04 17:03:49 +02:00
src group use statement, fix user sql 2023-05-04 17:03:49 +02:00
.env add required packages, env and database connection 2023-05-03 22:12:49 +02:00
.env.example add required packages, env and database connection 2023-05-03 22:12:49 +02:00
.gitignore project init 2023-05-03 21:56:43 +02:00
Cargo.lock add required packages, env and database connection 2023-05-03 22:12:49 +02:00
Cargo.toml add state for dependency management and user, token service 2023-05-03 22:42:43 +02:00
README.md update readme 2023-05-03 23:12:59 +02:00

README.md

Axum-Rust-Api-Boilerplate

This project is an open source boilerplate built with Rust's Axum framework.

Why this project?

I have been learning rust for some time now and I noticed a lack of open source axum boilerplates that define directory structure the way I like and I'm used to. Most other projects have all the code placed in a single main.rs file.

Features

This project uses Axum framework and SQLx for DB access layer, as well as other wonderful packages. It includes three basic routes: register, login, and profile page.

Getting Started

  1. Clone the project
  2. Update .env file with your DB credentials
  3. Install sqlx-cli or run cargo sqlx database create to create your DB
  4. Run the migration file using cargo sqlx migrate run. This will run the migration file that exists in the migration folder in the root of the project.
  5. Build the project and dependencies using cargo build
  6. Run the project using cargo run -- up

Contributing

Contributions are always welcome!