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 add their own GitHub repositories and explore repositories all within a simple and intuitive environment.

Table of Contents

• Installation
• Usage
• Screenshots
• 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

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
[email protected]

Christine
Github
[email protected]

Elisabeth
Github
[email protected]

Tanner
Github
[email protected]

License

Usage is provided under the MIT license.