Skip to content
This repository has been archived by the owner on Jul 29, 2018. It is now read-only.

womenhackfornonprofits/pimpmycause-rebuild

Repository files navigation

Build Status Test Coverage Code Climate

Pimp My Cause

Rebuild of the Pimp My Cause website. Powered by Women Hack For Non Profits

Set Up

  1. Clone the repo: git clone git@github.com:womenhackfornonprofits/pimpmycause-rebuild.git
  2. Install NPM to manage packages.
  3. Run npm install this will install all packages and the Pencil Blue CMS CLI in the package.json file.
  4. Install Grunt
  5. Install Homebrew, if you have it already make sure it is up to date with brew doctor
  6. Install MongoDB with brew install mongodb.
  7. Create the DB folder mongo needs to use mkdir -p /data/db

Notes: you might need to use sudo.

Running on your local machine

To run the project on your local machine in the terminal: mongod Then in a new terminal tab (or a new terminal on windows) run: nodemon main

This will connect the application to your local mongo instance and will start the PencilBlue CMS. You will then be able to view it in your browser on http://localhost:8080/

Seeding your local database

  1. mongo Then in a new tab of the terminal follow the steps:
  2. use pimp_my_cause
  3. load('./seeder.js') you should get ture if there are no errors
  4. db.getCollectionNames() You should get a list of all the collections in the 'pimp_my_cause' database.

Note: You will need to go through these steps only when you want to reset your local 'pimp_my_cause' database. There is no need to run this every time you are working on the project.

Technology Stack

Backend Frontend
Node.js HTML
MongoDB CSS

Continuous Integration, Code Coverage and Unit Tests

All builds are performed by Travis-CI and can found here. To view details of our code coverage visit Code Climate and we are using Mocha as our testing framework.

The Team

Front End Developers

Back End Developers

Testers/QA

Notes: Please review the PencilBlue repo for source code updates and PencilBlue APIs for documentations.

For latest updates and FAQ, please visit the PencilBlue Gitter