gitgud-server

A validator of your GitHub profile and Git use, designed to provide feedback for job seekers and graduated students.
You can find the repository for the client side here.

Table of contents:

• How
• Why
• Who
• Technologies
• Running the app locally
• Deployment server to Heroku

How

1. It checks your public profile - A good GitHub profile can impress an interviewer.
2. It validates your pinned repositories on how you use Git - Proper use of version control with Git can show that you are a structured worker and are able to work in development teams. We chose to focus on your pinned repos because you can present certain project as your portfolio for potential employers
3. It is possible to go to individual repositories and look at their ratings, this can be done by typing github-name/repo-name in the form.
4. It is also possible to search for multiple public profiles by typing the usernames separated by a space and clicking Go! When the results are in you can create a group with the users and their scores.
5. It supports searching for previously created groups.
6. It supports markdown files which include guidelines on how to build and polish your GitHub profile and repositories.

Why

• You can use GitHub as your resume for job hunting. For developers it is important to code regularly, be able to work in teams, communicate properly and continue with a learning curve. Obviously this is something you can say you are the best in and write it on your resume, but with GitHub you are able to show that you can do this. Which will give you heads-up on your next interview.
• Unfortunately many recent graduates or job seekers lack a proper GitHub profile. And as Codaisseur teachers can acknowledge, the feedback they get is repetitive. Therefore we developed this tool and provide constructive feedback which is based on various resources across the internet and uses live data from the GitHub API.

Who

• Oleksandra Akulshyna - Initial work - w3bgir1
• Vincent de Graaf - Initial work - vdegraaf
• Natalia Volchatova - Initial work - Klackky
• Demmy Honore de Vries demmyhonore
• Mario Nezmah - Repository page - mnezmah
• Jelle Monen jelle89
• Duc Trinh Ducatrinh
• Shawn Wu Mqspx800
• Halyna Burdiian Verdie
• Subash Pradhan SubashPradhan
• Olga Lokoshchenko loklock
• Andreea Cucos andreeaccss

Technologies

• TypeScript, TypeORM, GraphQL, Apollo/KoaServer, Face-api.js
• GitHub API v4 - GraphQL

Next steps for the students continuing this project

• Improve naming in the server directory (files, functions and variables), so structure is more understandable
• Schema.ts file can be splitted into two files, one only defining type and other with resolver
• Extra feature: Feedback on the commit usage of individuals when there is multiple contributors on the project
• Adjust scores for repositories depending on proper use of .gitignore file and README

Running the app locally

• Server needs to be launched with GitHub token to enable GitHub API requests.
  See instructions to create GitHub token here. (Don't forget to check user's scopes!)
• File client/src/index.js contains the server url. If you want to run local server, change it to your localhost.
• Setup a local postgresql database (username: postgres, password:secret)
• In the terminal, run

> git clone [email protected]:Official-Codaisseur-Graduate/gitgud-server.git
> cd gitgud-server
> npm install
> GITHUB_ACCESS_TOKEN=<YOURTOKEN> npm run dev

Deployment server to Heroku

> git remote add heroku https://git.heroku.com/gitgud-server.git
> git push heroku master

Acknowledgments

Special thanks to Rein op 't Land, our teacher and Product Owner.

• Rein op 't Land - ReinoptLand