Skip to content

Latest commit

 

History

History
207 lines (152 loc) · 6.65 KB

README.MD

File metadata and controls

207 lines (152 loc) · 6.65 KB
Raw

Contributors Forks Stargazers Issues LinkedIn


Rust Clean Architecture Api

An simple project template to demonstrate a api with clean architecure in Rust
Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Roadmap
  4. Contributing
  5. License
  6. Contact
  7. Acknowledgments

About The Project

This project was born out of a passion for exploring the intricacies of crafting APIs with Rust, delving into the clean architecture paradigm. It's not just about code; it's a journey into the heart of Rust's capabilities, all in the name of honing my skills and understanding the artistry behind clean and efficient API design.

(back to top)

Built With

  • Rust
  • Axum
  • SurrealDB

Getting Started

Prerequisites

If you to want the feature to run in watch mode, install cargo-watch

  • cargo-watch 
    cargo install cargo-watch

Installation

  1. Clone the repo 
    git clone https://github.com/vitorlfaria/rust_clean_api.git
  2. Build the project to install the dependecies 
    cargo build
  3. Run with 
    cargo run
    Or, for more dynamic development, run in watch mode 
    cargo watch -q -c -w src/ -x run
    -q quiet mode
    -c clear the console on reload
    -w watch all change to files under src/
    -x executes run command

(back to top)

Roadmap

  • Working api structure
  • Clean Architecure
  • Database
  • Authentication
    • Create user
    • Authenticate with JWT

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'feat: add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Vitor Lacerda - @vitorlacerdaf - [email protected]

Project Link: https://github.com/vitorlfaria/rust_clean_api

(back to top)

Acknowledgments

(back to top)