Skip to content

MylesWritesCode/web-api-with-axum

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

25 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation


Logo

Web API with Axum

Some example code of a web API with Axum in Rust
Explore the docs »

View Demo · Report Bug · Request Feature

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

About The Project

Product Name Screen Shot

This is your basic Rust CLI starter kit. Most of the README isn't going to make sense until I figure out exactly what and how I want the project to be built. In the meantime, feel free to use this as-is.

(back to top)

Built With

(back to top)

Getting Started

Prerequisites

Installation

  1. Clone the repo

    git clone git@github.com:MylesWritesCode/web-api-with-axum.git
    
  2. Install SeaORM as a migration tool

    cargo install sea-orm-cli
    
  3. Run docker. This will create the primary db.

    docker compose up -d
    
  4. Run initial server start

    cargo run -- server start
    

(back to top)

Usage

This repo is meant to be used as a template for Rust CLI programs. Metadata files will be within the .meta folder. In there, you'll find places to put your project logo and screenshot. Importantly, you'll find a fresh README.md that you can use to overwrite this one.

Happy hacking!

For more examples, please refer to the Documentation

(back to top)

Roadmap

  • Feature 1
  • Feature 2
  • Feature 3
    • Nested Feature

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

(back to top)

Contributing

Contributors

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 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

MIT License

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

(back to top)

Contact

Myles Berueda

Twitter

LinkedIn

(back to top)

About

A web API built with Rust and axum

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published