Playwilmington.org

This is the repo for the Children’s Museum of Wilmington.

Status

To get started with development on this site you will need to follow the below steps.

Install these softwares on your machine, (Mac-OSX) used below for commands

Install PostgresApp to use as your database.

Install X-Code

$ xcode-select --install

Install Homebrew

$ ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

Install Git

$ brew install git

Install Ruby using RVM

$ curl -L https://get.rvm.io | bash -s stable --auto-dotfiles --autolibs=enable --rails

Update Ruby version to 2.4.0

$ rvm install 2.4.0
$ rvm use 2.4.0 --default

Install Image Magic

$ brew install imagemagick

Setting up the Repo

Change to whatever folder you want to store everything in.

Clone Git Repo

$ git clone https://github.com/playwilmington/playwilmington.org.git && cd playwilmington.org

Install Gems

$ bundle install

Setup Databases

$ rails db:create
$ rails db:migrate
$ rails db:seed

Start Server

$ rails s

Navigate to localhost:3000 to begin using.

Below are commands to run tests and then linters all should be done before each commit to ensure successful deployments.

We use Minitest for all Rails Test Coverage

$ rails test

Rubocop - Checks ruby on rails .rb files

$ rubocop -D

Haml Linter - Check all Views .haml files

$ rake haml_lint

SCSS Linter - Checks all Stylesheets .scss files

$ rake scss_lint

Note: This creates a new file in project repo

YAML Linter - Checks all Yaml .yml files

$ rake yaml_lint

Deployments are all automated to Heroku from CircleCi. We have staging and production sites.

Development branch goes to Staging while master branch goes to Production Site.

We use SemVer for versioning. For the versions available, see the tags on this repository.

See also the list of contributors who participated in this project.