Rocket 🚀

A simple web framework with several purposes:

• Gather developers from different programming worlds
• Learn and, hopefully, permit others to learn

Rocket is built upon the Crystal programming language.

Rocket is inspired by Rails, but doesn't aim to be an exact copy of it. The goal is to gather as many programming experiences as possible to develop a great mix of awesome features.

⚠️ The project is at a very early stage.

Installation

If you're new to Crystal you may first want to install the language.

Then you can add this to your application's shard.yml:

dependencies:
  rocket:
    github: aurelien-ldp/rocket

Usage

require "rocket"

# Define your controllers and actions as you wish
class HelloController < Rocket::Controller
  def get
    "GET !"
  end

  def post
    "POST: #{context.request.body}"
  end

  def put
    "PUT !"
  end

  def patch
    "PATCH !"
  end

  def delete
    "DELETE !"
  end

  def param
    "#{params}"
  end
end

# Add routes to the router
Rocket::ROUTER.add_route("GET", "/", HelloController, "get")
Rocket::ROUTER.add_route("POST", "/posts", HelloController, "post")
Rocket::ROUTER.add_route("PUT", "/", HelloController, "put")
Rocket::ROUTER.add_route("PATCH", "/", HelloController, "patch")
Rocket::ROUTER.add_route("DELETE", "/", HelloController, "delete")

# With parameters
Rocket::ROUTER.add_route("GET", "/hello/:name/:id/:nb", HelloController, "param")

# Start the server (default port is 3000)
# You can also add the port with Rocket::Server.start(3000)
Rocket::Server.start

Now you can go to http://localhost:3000 or http://localhost:3000/hello/world/how/are?you&doing=good !

Development

Rocket is under active development. All contributions are very welcome ! Please refer to the Github's Project panel to see the list of features to develop.

Contributing

1. Fork it ( https://github.com/aurelien-ldp/rocket/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

Contributors

• aurelien-ldp Aurelien Louis Dit Picard - creator, maintainer