Table of Contents
✨ 🗺️
About The Project This project helps fellows to track their journey so far in the fellowship and showcase their progress. We leverage on personalized GitHub data that is fetched when a fellow logins in using GitHub authentication. The project will help fellows focus on their goals in the fellowship and pod leaders can using use this tool to monitor fellow's progress.
Some of the personalized data/metrics provided to a fellow are:
- User profile picture
- User profile name
- User location
- Number of issues
- Number of commits
- Number of Pull Requests
- Lines of code written
A list of commonly used resources that we find helpful are listed in the acknowledgements.
Screenshots of the web app
💻 ☀️
Built With
Getting Started
This section will work you through how you can get started with the project.
Installation
- You will need the GitHub
CLIENT_ID
andCLIENT_SECRET
for this project. - Clone the repo
git clone https://github.com/MLH-Fellowship/MyMLHJourney.git
- CD into the project directory
cd MYMLHJourney;
- CD into my-fellowship folder
cd my-fellowship;
- Install NPM packages
npm install
- Start the Server
npm start
Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
License
Distributed under the MIT License. See LICENSE
for more information.
Contributors
- Sarthak Khattar - sarthakoct@gmail.com
- Anastasiya Uraleva - anastasiyauraleva@gmail.com
- Grace Omotoso - gracomot@gmail.com
- Angelina Gasharova - andji.gash@gmail.com
Project Link: https://github.com/MLH-Fellowship/MyMLHJourney