Gitworkd

Gitworkd is a platform for hosting and exploring open source projects. It is easy to get lost in the vast world of GitHub, so we thought it would be beneficial to create a centralized ground for users to post projects and applications that are exclusively open to collaboration. Users are able to explore repositories posted by other users, save those repositories, and add their own repositories all within a simple and intuitive environment.

Table of Contents

• Installation
• Usage
• Resources
• Contributions
• Testing
• Questions
• License

Installation

If you would like to use the application in your local environment:

1. Clone the repo

2. Install required dependencies by running command npm i

3. Edit config.js file to match your MySQL credentials

4. Run schema.sql file to create MySQL database

5. Run command node server to get started

Otherwise, visit the deployed application here

Usage

Sign In

When you click the "Sign In With GitHub" button, you are authorizing GitWorkd to retrieve your GitHub information. If successful, you will be redirected to the main feed, which displays your GitHub information and repos that other users have posted.

Add Repos

This is where you are able to add your own GitHub repos. Upon pageload, our application fetches your repository information via the GitHub API,and displays it. Simply select all the repos you want other users to see on the main feed, and click submit. You can select multiple repos at a time and they will all be added.

Main Feed

This is our main feed and the bulk of our application. You are able to view other repos that users have posted, see which languages are used in their applications, and save them to your saved repos page. Notice that you will not see your added repos on the main feed, however, other users will be able to view them on their personal feed.

Saved Repos

With our saved repos page, you are able to log repos that you are interested in collaborating with. In a simple table format, the repos will be listed with the title, author, and link for you to view the GitHub repository.

Resources

Node.js
MySQL
Handlebars
Express
Bootstrap
GitHub API
Heroku
Font Awesome
Google Fonts

Contributions

All contributions to this project are welcome! Clone down the repo to your local machine, commit changes, push to GitHub, and open a pull request!

Testing

No tests are set up for Gitworkd at this time. Feel free to write tests or search the application for bugs.

Questions

If you have any further questions, feel free to reach out to us!

Alex
Github
nickelbot5.3@gmail.com

Christine
Github
cmoorelvt@gmail.com

Elisabeth
Github
eaclumpkens@gmail.com

Tanner
Github
twk4491@gmail.com

License

Usage is provided under the MIT license.