Billion Oyster Project Digital Platform

The Billion Oyster Project is an ecosystem restoration and education project designed to restore one billion live oysters to New York Harbor. Our BOP Schools and Community Science program seeks to increase the skills, content knowledge, and confidence of underrepresented groups in STEM (Science, Technology, Engineering, Math) fields through hands on, authentic restoration and research activities. The BOP Digital Platform is the online dashboard for our program. Through the Platform, students and teachers collect and publish data, develop field research, and create the STEM curriculum that links keystone species restoration in New York Harbor to teaching and learning in New York City Schools. You can check out the BOP Digital Platform User Guide here.

In light of our goals, we're strongly committed to making the Billion Oyster Project Digital Platform an inclusive, welcoming open source community. Before contributing to the project, please read our Code of Conduct.

This project is based off the MEAN.js stack

Before starting, have the following installed on your system

• Node.js - Download and Install Node.js or use the packages within brew or macports.

• MongoDB - Follow the tutorial here - Install mongodb on OSX

• git - Get git from here.

• java - Download and install or use the package within brew (brew cask install java)

• ruby - Download and install or use the package within brew (brew install ruby)

• sass - gem install sass

• using npm version - 3.6.0

• using node version - 5.6.0

Getting Started

Install globals and build.

# You can use nvm to install any Node.js (or io.js) version you require.
nvm install 4.3.0

npm install -g grunt-cli

npm install -g gulp

npm install -g bower

npm install

bower install

To generate a new scaffold

npm install -g yo

npm install -g generator-meanjs

To load data

cd scripts/mongo-load

./load-data-into-mongo.sh

Once you have cloned down this project, run:

cd Digital-Platform

npm install

#make sure mongo is running

grunt

open the browser to -  http://localhost:8081

To run the Protractor tests:

npm install -g protractor

#in one terminal

webdriver-manager update

webdriver-manager start #this is the only command you'll need to start the server once it's installed

#in a separate terminal
grunt test:e2e