Skip to content

Commit

Permalink
init commit
Browse files Browse the repository at this point in the history
todo::
* driver compiler
* testing framework (web based)
* monitor the drivers folder for changes (trigger spec runs etc)
  • Loading branch information
stakach committed Mar 18, 2019
1 parent d15289a commit eb8c417
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 66 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ lib
app
*.dwarf
bin
.DS_Store
23 changes: 0 additions & 23 deletions Dockerfile

This file was deleted.

44 changes: 3 additions & 41 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,5 @@
# Spider-Gazelle Application Template
# Crystal Engine Drivers

[![Build Status](https://travis-ci.org/spider-gazelle/spider-gazelle.svg?branch=master)](https://travis-ci.org/spider-gazelle/spider-gazelle)
[![Build Status](https://travis-ci.org/aca-labs/crystal-engine-drivers.svg?branch=master)](https://travis-ci.org/aca-labs/crystal-engine-drivers)

Clone this repository to start building your own spider-gazelle based application

## 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`
Manages and tests engine drivers
2 changes: 0 additions & 2 deletions shard.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ dependencies:
action-controller:
github: spider-gazelle/action-controller
version: "~> 1.4"
active-model:
github: spider-gazelle/active-model

# https://github.com/jeromegn/kilt
# Generic template interface for Crystal
Expand Down

0 comments on commit eb8c417

Please sign in to comment.