runners_plaza

master branch1 version

master branchlatestApr 21, 2020

github.com/Runners-Plaza/API

No description declared in shard.yml.

2 stars

0 dependents

License: MIT License

Installation

# Add this to your shard.yml
dependencies:
  runners_plaza:
    github: Runners-Plaza/API
    branch: master

master is a branch, not a release, so this tracks it rather than pinning a version.

Then run:

shards install

shard.yml

Crystal

0.34.0

License

MIT License

Author

Tatsiujin Chin

Targets

amber from lib/amber/src/amber/cli.cr
runners_plaza from src/runners_plaza.cr

Dependencies

Runtime Dependencies

amber~> 0.34.0github: amberframework/amber
shale~> 0.2.4github: c910335/shale
crinder~> 0.2.0github: c910335/crinder
granite*github: c910335/granite, branch: association-improvements
citrine-i18n~> 0.4.0github: amberframework/citrine-i18n

Development Dependencies

ameba~> 0.12.1github: crystal-ameba/amebadev
webmock~> 0.12.1github: manastech/webmock.crdev
mass_spec~> 0.3.1github: c910335/mass-specdev

README

Runners' Plaza API

This is a project written using Amber. Enjoy!

Todo

[ ] not just template in READMD.md

Getting Started

These instructions will get a copy of this project running on your machine for development and testing purposes.

Please see deployment for notes on deploying the project in production.

Prerequisites

This project requires Crystal (installation guide).

Development

To start your Amber server:

Install dependencies with shards install
Build executables with shards build
Create and migrate your database with bin/amber db create migrate. Also see creating the database.
Start Amber server with bin/amber watch

Now you can visit http://localhost:3000/ from your browser.

Getting an error message you need help decoding? Check the Amber troubleshooting guide, post a tagged message on Stack Overflow, or visit Amber on Gitter.

Using Docker? Please check Amber Docker guides.

Tests

To run the test suite:

crystal spec

Contributing

Fork it ( https://github.com/Runners-Plaza/API/fork )
Create your feature branch ( git checkout -b my-new-feature )
Commit your changes ( git commit -am 'Add some feature' )
Push to the branch ( git push origin my-new-feature )
Create a new Pull Request

Contributors

c910335 Tatsiujin Chin - creator, maintainer