Skip to content

Latest commit

 

History

History
50 lines (32 loc) · 1.95 KB

README.md

File metadata and controls

50 lines (32 loc) · 1.95 KB

Nu-tab

Codeship Status Code Climate Test Coverage Dependency Status

An attempt at APDA tabbing software built for 2017. The goal of this project is to port the tab logic of mit-tab into a web application with more robust testing, documentation & clarity

Getting Started

After you have cloned this repo, run this setup script to set up your machine with the necessary dependencies to run and test this app:

% ./bin/setup

It assumes you have a machine equipped with Ruby, Postgres, etc. If not, set up your machine with this script.

After setting up, you can run the application using Heroku Local:

% heroku local

Development

The back-end stack is a traditional ruby-on-rails app.

The front-end is build with the react_on_rails gem. The front-end React components live in the client directory. Tests are written using jest and packages are managed using yarn.

Guidelines

Use the following guides for getting things done, programming well, and programming in style.

Deploying

This project is automatically deployed to production & staging when the test suite passes on Codeship