francisngo / gitbud

A social platform for Github users to connect and collaborate on open source projects. API built with Node + Express + Neo4j database + PassportJS. Webapp built with React + Redux + Material UI. Bundled with Webpack.

GitBud

GitBud is an application that allows users to connect with others who are either at the same level or higher to work on open source projects. Users can view current projects, interested users, and pair up to work on a project together.

• Deployed Application Link

Team

• Product Owner: Shaikat Haque
• Scrum Master: Francis Ngo
• Development Team Members: Peter Warner-Medley, Brian Kim

Table of Contents

• Requirements
• Getting Started
• Development
  • Installing Dependencies
• Contributing

Requirements

• Node 0.10.x
• neo4j 3.x

Getting Started

Following these instructions will get you a copy of the project up and running for development purposes.

Environment Variables GitBud has hardcoded a username of 'neo4j' and a password of 'neo' for neo4j. You can change these in the code or override them by setting the appropriate environment variables. You will also need a GitHub Client ID and Client Secret to use the GitHub API. These, too, are set as environment variables. We have used the .env package, which allows environment variables to be set easily with the .env file in the root directory of the project. An example of the necessary variables for GitBud been provided here in this repo.

• Fork and clone the repo
• Install dependencies from the root of the repo by running

npm install

• Download and install neo4j
• Start the neo4j server (OS dependent)
• Seed the database by running:

npm run seed

• Transpile the JSX files with

npm run dev

NOTE This sets webpack to watch your /client files for changes

• Run the following command to start the server

npm start

NOTE This runs nodemon, which will watch server.js and your /server files for changes

• Open localhost:8080 in your browser to start using the application.

Development

Installing Dependencies

From within the root directory:

npm install

Download, install and run neo4j

Contributing

See CONTRIBUTING.md for contribution guidelines.