📃 Rust MVC Template

Bootstrap a Rust MVC application in seconds

Table of Contents

• Table of Contents
• 🏁 Getting Started
  • ⚙️ Configuration
  • 🎈 Usage
    • Hot reload
  • 🧰 Uses
  • 📄 License
• 🔭 Contributing
  • 🐛 Issues
  • 🤝 Pull Requests
• ✍️ Authors

🏁 Getting Started

This repository is a template for those who want to easily start developing a web Rust MVC application.

⚙️ Configuration

You can configure some settings by editing the .env file

🎈 Usage

1. Clone the repo
2. Start the backend with cargo run
3. Start the TailwindCSS compiler with npm run dev
4. Start coding

Hot reload

To make the backend reload automatically on file changes, you can use cargo watch library. Install it and run cargo watch -x run

🧰 Uses

• Axum - Backend Framework
• SeaORM - Database ORM
• Tera - Template Engine
• Htmx - HTML enhancer
• TailwindCSS - Database ORM

📄 License

MIT

🔭 Contributing

🎉 Thank you for being interested in contributing to Rust MVC Template project! 🎉

Feel welcome and read the following sections in order to know how to ask questions and how to work on something.

Please make sure you are welcoming and friendly in all of our spaces. 👍

🐛 Issues

The best way to contribute to the project is by opening a new issue or tackling one of the issues that are already open.

🤝 Pull Requests

Pull requests are great if you want to add a feature or fix a bug. Here's a quick guide:

1. Fork the repo. documentation changes require no new tests.
2. Make sure to check out the Style Guide and ensure that your code complies with the rules.
3. Commit your changes.
4. Push to your fork and submit a pull request. Please provide us with some explanation of why you made the changes you made.

✍️ Authors

• Luca Corsetti