Skip to content
forked from cranebaes/gitbud

An application to help programmers begin working on open source projects.

Notifications You must be signed in to change notification settings

Toucans456/GitPal

 
 

Repository files navigation

GitPal

GitPal is an application that was forked from GitBud 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.

Alt text

Table of Contents

  1. Team
  2. Preview
    1. Demo
    2. Screenshots
  3. Usage
  4. Requirements
  5. Development
    1. Installing Dependencies
    2. Tasks
    3. Roadmap
  6. More Information
    1. Server README
    2. Client README
  7. GitBud Repo
  8. Contributing

Team

  • Product Owner: Scott Schaefer
  • Scrum Master: Rick Gallegos
  • Development Team Members: Christine Zimmerman, Scott Mitchell, Sonrisa Chen

Preview

Demo

Click here to try out GitPal

Screenshots

Sample projects

Project page

User Profile

Navigation Drawer

My Partners page

Usage

Environment Variables GitPal 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 GitPal 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.

Requirements

Development

Installing Dependencies

From within the root directory:

npm install

Download, install and run neo4j

Roadmap

View the project roadmap here

More Information

Server README

View the GitPal server README here

Client README

View the GitPal client README here

GitBud Repo

View the original Repo here

Contributing

See CONTRIBUTING.md for contribution guidelines.

About

An application to help programmers begin working on open source projects.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 100.0%