spider-gazelle/guide

Spider Gazelle Documentation

Spider-Gazelle Application Template

Clone this repository to start building your own spider-gazelle based application. This is a template and as such, Do What the Fuck You Want To

Documentation

Detailed documentation and guides available: https://spider-gazelle.net/

• Action Controller base class for building Controllers
• Active Model base class for building ORMs
• Habitat configuration and settings for Crystal projects
• router.cr base request handling
• Radix Radix Tree implementation for request routing
• HTTP::Server built-in Crystal Lang HTTP server
  • Request
  • Response
  • Cookies
  • Headers
  • Params etc

Spider-Gazelle builds on the amazing performance of router.cr here.:rocket:

Testing

crystal spec

• to run in development mode crystal ./src/app.cr

Compiling

crystal build ./src/app.cr

Deploying

Once compiled you are left with a binary ./app

• for help ./app --help
• viewing routes ./app --routes
• run on a different port or host ./app -b 0.0.0.0 -p 80

guide's Issues

Reorder the documentation

In the "getting started" menu, the first page, which is also called "getting started", starts from an empty project and adds "action-acontroller" to it.
The other pages of this menu start from a clone of the "spider-gazelle" project but this clone is not mentioned anywhere.

I propose to switch the pages that start from the clone to the "new project" menu. And to rewrite the topics covered by starting from an empty project, for the "getting started" menu.

What do you think about it?