Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/garimasingh128/gitsetgo

A Github Resume generator 👨‍💻👩‍ to create your own personalised resume based on your Github profile. 🔎 This tool lets you have your resume on a single click.
https://github.com/garimasingh128/gitsetgo

css framework github hacktoberfest hacktoberfest2020 html js pdf profile react reactjs resume timeline

Last synced: about 1 month ago
JSON representation

A Github Resume generator 👨‍💻👩‍ to create your own personalised resume based on your Github profile. 🔎 This tool lets you have your resume on a single click.

Awesome Lists containing this project

README 

        

# 👣 Git Set Go

### 😃😃 A Github profile resume generator. ✨

![gitsetgo](https://socialify.git.ci/garimasingh128/gitsetgo/image?description=1&font=Source%20Code%20Pro&forks=1&issues=1&language=1&owner=1&pattern=Signal&pulls=1&stargazers=1&theme=Dark)







![Demo](./demo/demo.gif)



![Author](https://img.shields.io/badge/author-garimasingh128-orange)

![Author](https://img.shields.io/badge/author-mrinal41298-orange)

![License](https://img.shields.io/badge/license-MIT-brightgreen)

![Platform](https://img.shields.io/badge/platform-Visual%20Studio%20Code-blue)

![Maintained](https://img.shields.io/maintenance/yes/2020)

![Last Commit](https://img.shields.io/github/last-commit/mrinal41298/gitsetgo)

![Release Date](https://img.shields.io/github/release-date/mrinal41298/gitsetgo)

![Issues](https://img.shields.io/github/issues/mrinal41298/gitsetgo)

![Stars GitHub](https://img.shields.io/github/stars/mrinal41298/gitsetgo)

![Language](https://img.shields.io/github/languages/top/mrinal41298/gitsetgo)

![Size](https://img.shields.io/github/repo-size/mrinal41298/gitsetgo)



## 👩‍ Demo PDF generated











A Github Resume generator 👨‍💻👩‍ to create your own personalised resume based on your Github profile. 🔎 This tool lets you have your resume on a single click.



# Gitter Channel 💻👩‍

Join here for all discussions: https://gitter.im/KWoC2020/GitSetGo



# This project is a part of Hakin Codes 2020 👣

  OPEN SOURCE CONTEST - Hakin Codes

  ### About HakinCodes 2020 💻

  HakinCodes is founded with a vision to impart technical knowledge with practical implementations to all the students and developers around.



At HakinCodes it's our mission to provide guidance to the participants from the mentors who are highly skilled and experienced in particular stacks whether be it technical or non-technical.



At HakinCodes we are always here to solve any issues regarding the projects and providing golden opportunities to everyone who wants to improve their skills.



HakinCodes would always provide cutting edge experience to every developer in moving a step closer towards achieving their dreams.



HakinCodes will always try to maintain a positive attitude towards achieving higher goals and objectives.



At HakinCodes we maintain a trustworthy and healthy environment and respect each other's privacy 











⭐ [Check out the website of HackinCodes 2020](https://hakincodes.tech)



## 📋 Table of Contents

 ➡️   [Vision](#-vision)



 ➡️   [Project Structure](#-project-structure)

 

 ➡️   [Tech Stack](#-tech-stack)

 

 ➡️   [Setup Development Environment](#-steps-to-setup-development-environment)



 ➡️   [Development Guidelines](#-development-guidelines)

 

 ➡️   [Learning Resources](#-learning-resources)

 

➡️   [Future Plans](#-future-plans)



 ➡️   [System Requirements](#-system-requirements)

 

 ➡️   [Contributing](#-contributing)

 

 ➡️   [Owner](#-owner)

 

 ➡️   [How to run it locally?](#-Running-it-locally)



## 👩‍ Vision

Getting your Github profile under a single page in a resume type-of format so that you can simply put your Github resume when applying to internships or job profiles.



## ❤️ Inspiration

We were inspired to create it when we saw that not many tools are available open-source or on the Internet which do the job we intend to do. So we decided to create it as a side-project based purely to learn and have some fun juggling with Github APIs'.



## 🤷 Project Structure

    .

    ├── ...

    ├── .github

    │── node_modules

    │── public

    │── src (has all the components, JS files, CSS files etc. )

    |── all MD files

    |── images, demo video and templates

    └── ...

    

## 🔆 Tech Stack

The project is created using create-react-app and based on React.js framework.

-  JavaScript: 84.5%

-  HTML: 10.3%

-  CSS: 5.2%



## 👬 Design and Roadmap

The [Roadmap](https://www.figma.com/file/czzHjTUJS94Rl676D8up5s/GitSetGo?node-id=0%3A1) we intended to follow is present here. Feel free to suggest ideas and opinions.



## 🚀 Steps to setup development environment

1.  Clone the repo

 ```bash

 git clone github.com/your_username/gitsetgo.git

 ```

 2. Open the folder in your favorite code editor and start adding modifications.



 ## 💻 Development guidelines



1.  Put all the code in one of the existing files in  `/src`.

    

3.  Push all the code to your own branch. Once you are sure it is working, merge it with the `dev`  branch. Let's maintain only the stable and released versions on the  `master`  branch.

    

4.  Write a kick-ass, readable, and clean code.



## 📝 Learning Resources



Read these articles to get a quick grab on handling Github API's and other technologies used in the project:



### Resources for learning React.js:

- https://reactresources.com

- https://reactjs.org/community/external-resources.html

- https://reactjs.org/docs/getting-started.html

- https://github.com/enaqx/awesome-react



### Migrating from Rest API to GraphQL API:

- https://developer.github.com/v4/guides/migrating-from-rest/

- https://docs.github.com/en/graphql



### Resources for Github APIs':

- https://developer.github.com/v3/ 

- https://developer.github.com/v4/ 

- https://github.com/octokit/rest.js/ 

- https://github.com/octokit/graphql.js



### Resources for node.js:

- https://nodejs.org/en/about/resources/

- https://github.com/sindresorhus/awesome-nodejs

- https://www.tutorialsteacher.com/nodejs/nodejs-resources



### Resources for Prettier.io used in the project

- [Prettier.io used in the project](https://prettier.io)



### Resources to learn Git and Github:

- https://try.github.io/

- https://docs.github.com/en/github/getting-started-with-github/git-and-github-learning-resources

- https://guides.github.com/activities/hello-world/



## ✨ Future Plans

- Github Timeline 

- Github competition between two users

- Personalised template for resume

- Enhancing the existing resume template

- Showing Github feed of others



`Feel free to create issues to suggest and add functionalities and features.`



## 💻 System Requirements

-  Google Chrome

-  Git

-  Code Editor (Visual Studio Code, Sublime Text)



## 🏆 Contributing



Please read  [CONTRIBUTING.md](CONTRIBUTING.md)  for information on how to contribute to profext-extension.



##  💼  Code of Conduct



We want to facilitate a healthy and constructive community behavior by adopting and enforcing our code of conduct.



Please adhere towards our [code-of-conduct.md](code-of-conduct.md).



## 👬 Owner




Garima Singh



Mrinal Kumar



[![built with love](https://forthebadge.com/images/badges/built-with-love.svg)](https://github.com/mrinal41298/)



## ❤️ Thanks to our awesome contributors.



## ✨ Running it locally



This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).



## Available Scripts



In the project directory, you can run:



### `npm start`



Runs the app in the development mode.


Open [http://localhost:3000](http://localhost:3000) to view it in the browser.



The page will reload if you make edits.


You will also see any lint errors in the console.



### `npm test`



Launches the test runner in the interactive watch mode.


See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.



### `npm run build`



Builds the app for production to the `build` folder.


It correctly bundles React in production mode and optimizes the build for the best performance.



The build is minified and the filenames include the hashes.


Your app is ready to be deployed!



See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.



### `npm run eject`



**Note: this is a one-way operation. Once you `eject`, you can’t go back!**



If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.



Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.



You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.



## Learn More



You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).



To learn React, check out the [React documentation](https://reactjs.org/).



### Code Splitting



This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting



### Analyzing the Bundle Size



This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size



### Making a Progressive Web App



This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app



### Advanced Configuration



This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration



### Deployment



This section has moved here: https://facebook.github.io/create-react-app/docs/deployment



### `npm run build` fails to minify



This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify