https://github.com/nickbclifford/mymicds-v2-ruby
MyMICDS-v2 but every time JavaScript, Ruby
https://github.com/nickbclifford/mymicds-v2-ruby
mymicds ruby sinatra
Last synced: 10 months ago
JSON representation
MyMICDS-v2 but every time JavaScript, Ruby
- Host: GitHub
- URL: https://github.com/nickbclifford/mymicds-v2-ruby
- Owner: nickbclifford
- License: mit
- Created: 2017-02-02T17:04:20.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-02-17T04:14:34.000Z (over 9 years ago)
- Last Synced: 2025-03-06T16:16:39.592Z (over 1 year ago)
- Topics: mymicds, ruby, sinatra
- Language: Ruby
- Size: 58.6 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MyMICDS-v2-Ruby
This is a rewrite of [MyMICDS-v2](https://github.com/michaelgira23/MyMICDS-v2), but in Ruby instead of JavaScript.
## Setup
### Dependencies
Before you can run this repository, you have to run `bundle install` to install all the required dependencies. **However**, if you are not using MRI (i.e. you're on Windows), you have to manually install bcrypt with `gem install bcrypt --platform=ruby`.
### Config
You also have to set up a local config file on every machine. This file contains all the credentials and such that are required for proper operation. Use `config.example.yaml` as a model to create a `config.yaml` with all the information properly filled out. This will not be committed, so don't worry.
## Running
Just run the `rackup` command in this directory to start the server. By default, it runs on port 1420, but this can be changed with the `-p` flag.
## Wait, why are you throwing errors if a user, teacher, etc. isn't found?
If you take a look at the `routes` files, *all* the errors are caught and the message is displayed. If I did something like returning `false`, I would have to add special clauses. Besides, if you look at the JavaScript API, an error is placed in the callback anyway, so it's still relatively consistent.
## TODO
- `rdoc` file documentation
- [RAML](http://raml.org/) API documentation
- everything else