/MyMLHJourney

Wrap up your MLH experience

Primary LanguageJavaScriptMIT LicenseMIT


Logo

Table of Contents
  1. About The Project
  2. Getting Started
  3. Contributing
  4. License
  5. Contributors
  6. Acknowledgements

License Size Stars Forks

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

Logo

Logo

Logo

Built With 💻☀️

Getting Started

This section will work you through how you can get started with the project.

Installation

  1. You will need the GitHub CLIENT_ID and CLIENT_SECRET for this project.
  2. Clone the repo
    git clone https://github.com/MLH-Fellowship/MyMLHJourney.git
  3. CD into the project directory
    cd MYMLHJourney;
  4. CD into my-fellowship folder
    cd my-fellowship;
  5. Install NPM packages
    npm install
  6. 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.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contributors

  1. Sarthak Khattar - sarthakoct@gmail.com
  2. Anastasiya Uraleva - anastasiyauraleva@gmail.com
  3. Grace Omotoso - gracomot@gmail.com
  4. Angelina Gasharova - andji.gash@gmail.com

Project Link: https://github.com/MLH-Fellowship/MyMLHJourney

Acknowledgements ✔️