https://github.com/spider-gazelle/spider-gazelle

A Rails esque web framework with a focus on speed and extensibility for crystal lang
https://github.com/spider-gazelle/spider-gazelle

Last synced: about 1 month ago
JSON representation

A Rails esque web framework with a focus on speed and extensibility for crystal lang

• Host: GitHub
• URL: https://github.com/spider-gazelle/spider-gazelle
• Owner: spider-gazelle
• License: wtfpl
• Created: 2018-02-03T06:25:30.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2024-07-28T02:09:31.000Z (5 months ago)
• Last Synced: 2024-08-01T17:36:56.853Z (4 months ago)
• Language: Crystal
• Homepage: https://spider-gazelle.net/
• Size: 104 KB
• Stars: 180
• Watchers: 9
• Forks: 9
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-crystal - spider-gazelle - A Rails esque web framework with a focus on speed and extensibility (Web Frameworks)
• awesome-crystal - spider-gazelle - A Rails esque web framework with a focus on speed and extensibility (Web Frameworks)
• awesome-crystal - spider-gazelle - A Rails esque web framework with a focus on speed and extensibility (Web Frameworks)

README

        
# Spider-Gazelle Application Template

[![CI](https://github.com/spider-gazelle/spider-gazelle/actions/workflows/ci.yml/badge.svg)](https://github.com/spider-gazelle/spider-gazelle/actions/workflows/ci.yml)

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](https://github.com/spider-gazelle/action-controller) base class for building [Controllers](http://guides.rubyonrails.org/action_controller_overview.html)

* [Active Model](https://github.com/spider-gazelle/active-model) base class for building [ORMs](https://en.wikipedia.org/wiki/Object-relational_mapping)

* [Habitat](https://github.com/luckyframework/habitat) configuration and settings for Crystal projects

* [router.cr](https://github.com/tbrand/router.cr) base request handling

* [Radix](https://github.com/luislavena/radix) Radix Tree implementation for request routing

* [HTTP::Server](https://crystal-lang.org/api/latest/HTTP/Server.html) built-in Crystal Lang HTTP server

  * Request

  * Response

  * Cookies

  * Headers

  * Params etc

Spider-Gazelle builds on the amazing performance of **router.cr** [here](https://github.com/tbrand/which_is_the_fastest).: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`