Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mlh-fellowship/mymlhjourney

Wrap up your MLH experience and learn about your journey as an MLH Fellow
https://github.com/mlh-fellowship/mymlhjourney

firebase github-api graphql javascript react

Last synced: 19 days ago
JSON representation

Wrap up your MLH experience and learn about your journey as an MLH Fellow

Awesome Lists containing this project

README

        





Logo

Table of Contents



  1. About The Project



  2. Getting Started


  3. Contributing

  4. License

  5. Contributors

  6. Acknowledgements

![License](https://img.shields.io/github/license/MLH-Fellowship/MyMLHJourney?style=for-the-badge)
![Size](https://img.shields.io/github/languages/code-size/MLH-Fellowship/MyMLHJourney?style=for-the-badge)
![Stars](https://img.shields.io/github/stars/MLH-Fellowship/MyMLHJourney?style=for-the-badge)
![Forks](https://img.shields.io/github/forks/MLH-Fellowship/MyMLHJourney?style=for-the-badge)

# 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

## Deployed @https://mymlhjourney.netlify.app/

## Built With πŸ’»β˜€οΈ

* [GraphQL](https://graphql.org/)
* [React](https://reactjs.org/)
* [JavaScript](https://www.javascript.com/)
* [Firebase](https://https://firebase.google.com/)

## 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
```sh
git clone https://github.com/MLH-Fellowship/MyMLHJourney.git
```
3. CD into the project directory
```sh
cd MYMLHJourney;
```
4. CD into my-fellowship folder
```sh
cd my-fellowship;
```
5. Install NPM packages
```sh
npm install
```
6. Start the Server
```sh
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 - [email protected]
2. Anastasiya Uraleva - [email protected]
3. Grace Omotoso - [email protected]
4. Angelina Gasharova - [email protected]

* Special thanks to [Pawan Kolhe](https://github.com/PawanKolhe) for helping with props and routing in React!

Project Link: [https://github.com/MLH-Fellowship/MyMLHJourney](https://github.com/MLH-Fellowship/MyMLHJourney)

## Acknowledgements βœ”οΈ
* [GitHub Emoji Cheat Sheet](https://www.webpagefx.com/tools/emoji-cheat-sheet)
* [AdobeXd](https://www.adobe.com/)
* [Figma](https://www.figma.com/)
* [Gang of Three](https://www.fontzillion.com/fonts/vic-fieger/gang-of-three)
* [Animation Made Easy](https://loading.io/)
* [Choose an Open Source License](https://choosealicense.com)
* [GitHub Pages](https://pages.github.com)