rustyroad 0.1.6

Rusty Road is a framework written in Rust that is based on Ruby on Rails. It is designed to provide the familiar conventions and ease of use of Ruby on Rails, while also taking advantage of the performance and efficiency of Rust.
Documentation

Hackathon Status GitHub Issues GitHub Pull Requests License

📝 Table of Contents

🧐 Problem Statement

Rust Needs a Rails

I outlined this in a blog post here: https://rileyseaburg.com/posts/rust-needs-a-rails

  • IDEAL: In a perfect world, Rust would have a framework that is as easy to use as Ruby on Rails. It would be easy to learn, easy to use, and easy to maintain. It would be fast, secure, and reliable. It would be extensible and customizable. It would be a joy to use.
  • REALITY: Rust is a powerful language, but it is not easy to use. It is not easy to learn, and it is not easy to maintain. It is not fast, secure, or reliable. It is not extensible or customizable. It is not a joy to use even though it is the most loved programming language on stack overflow.
  • CONSEQUENCES:
    • Web servers are insecure, because most languages are not as secure as Rust.
    • Web servers are slow, because most languages are not as fast as Rust.
    • Web servers are unreliable, because most languages are not as reliable as Rust.
    • Web servers are not extensible or customizable, because most languages are not as extensible or customizable as Rust.
    • Web servers are not a joy to use, because most languages are not as fun to use as Rust.

💡 Idea / Solution

Rusty Road is a framework written in Rust that is based on Ruby on Rails. It is designed to provide the familiar conventions and ease of use of Ruby on Rails, while also taking advantage of the performance and efficiency of Rust.

:dog: What is Rusty Road

Rusty Road is a framework written in Rust that is based on Ruby on Rails. It is designed to provide the familiar conventions and ease of use of Ruby on Rails, while also taking advantage of the performance and efficiency of Rust.

Rusty Road is intended to offer developers a powerful and reliable platform for building web applications using Rust, and its name incorporates a rust-themed crab pun in a playful and memorable way.

Understanding Rusty Road

Rusty Road currently works with the Rocket web framework, the Diesel ORM, the Tera template engine, the SASS asset pipeline, and the PostgreSQL database. It also uses the dotenv crate to manage environment variables, and it uses the dotenv-linter crate to lint environment variables.

Because Rusty Road uses the Rocket web framework, the architecture is not exactly MVC

🎈 Current Features

  • Database migrations
  • Database seeds
  • Support for PostgreSQL
  • Support for MySQL
  • Support for SQLite
  • Support for MongoDB (Planned)
  • Routing (Rocket)
  • Templating (Tera)
  • CSS Framework (Tailwind CSS)

⛓️ Dependencies / Limitations

  • Rust is a relatively new language, and it is not as mature as Ruby on Rails.
  • Rust is not as easy to use as Ruby on Rails.
  • Rust has a borrow checker, which can make it difficult to use.

🚀 Future Scope

  • Add support for more database adapters.
  • Add support for react.
  • Add support for GraphQL.
  • Add support for API based microservices.
  • Add support for more asset pipelines.
  • One click deployment to AWS, GCP, Azure, and Digital Ocean or provide a docker image.
  • Add support for more authentication frameworks.

🏁 Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

Rust is required to build and run Rusty Road. You can install Rust using rustup. rustup is a tool that helps manage Rust installations, it allows for installing multiple versions of Rust and switching between them easily.

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

Installing

Rusty Road Logo

Crates.io

Rusty Road is available on crates.io. You can install it using cargo:

cargo install rustyroad

Bonus Step #1 (optional): Add the following to your .bashrc or .zshrc file to make the rustyroad command available in your terminal:

export PATH="$HOME/.cargo/bin:$PATH"

Bonus Step #2 (optional): Create a symbolic link to the rustyroad command in your ~/.cargo/bin directory. This will create a symlink from rustyroad to rr inside ~/.cargo/bin/ directory. Now you can invoke rr command which is just a symlink to rustyroad.

sudo ln -s ~/.cargo/bin/rustyroad /usr/local/bin/rr

(Windows users can download the executable from the releases page and add it to their PATH.)

Installing from source

Clone the repository and run the setup script.

git clone https://github.com/RileySeaburg/RustyRoad

cd RustyRoad

cargo run

🎈 Usage

The cli will prompt you to create a new project. Enter the name of your project and the cli will create a new project in the current directory.

$ rustyroad

CLI for Rusty Road


Usage: rustyroad.exe <COMMAND>

Commands:

  new       Creates a new project

  generate  Generates a new route, model, or controller

  migrate   Runs migrations

  help      Print this message or the help of the given subcommand(s)

Options:

  -h, --help  Print help

Follow the command flow to create a new project

rustyroad new my_project

Generate a new route

rustyroad generate route users

⛏️ Built With

✍️ Authors

See also the list of contributors who participated in this project.

🎉 Acknowledgments

  • Creator of Ruby on Rails, David Heinemeier Hansson (DHH)
  • Creator of Rust, Graydon Hoare
  • Creator of Rocket, Sergio Benitez