README.md

Observatory3

A project tracking dashboard for Rensselaer Center for Open Source. A ground up rewrite.

Working to replace a system with these features. See our planned feature set.

Features

Observatory is a powerful dashboard tracking open source projects and contributors that are built through Rensselaer Center for Open Source. The current implemenation can be seen in action at rcos.io. We are a highly active community of open source developers that attend school at Rensselaer.

Key Features Include

• Project Tracking
• Individual Progress reports
• Attendance system for users
• Information gathering and blog platform for projects

Getting Started

Prerequisites

• Git

• Node.js and npm Node ^4.2.3, npm ^2.14.7 (nodejs-legacy for debian-based distributions)

• Docker

• Docker-Compose

• Bower (npm install --global bower)

• Grunt (npm install --global grunt-cli)

npm install -g grunt-cli grunt bower

Developing

1. Run npm install to install server dependencies.

   if you have errors running the above, try:

   sudo chown -R $USER ~/.npm
   

2. Run bower install to install front-end dependencies.

3. Run docker-compose up -d to start a MongoDB instance.

   This also starts a Mongo-Express admin interface available at http://localhost:8081.

4. Run grunt serve to start the development server. It should automatically open the client in your browser when ready.

   Grunt will run the server and make the project available at http://localhost:9000.

Build & preview

Run grunt build for building and grunt serve for preview.

Seeding the Database

Run grunt seed to seed (populate) your mongoDB with dummy data

Testing

Running npm test will run the unit tests with karma.

Want to develop with us? This project was generated with the Angular Full-Stack Generator version 3.3.0.