Git Set Go
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.
Repository Video βΆοΈπ©β 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 we intended to follow is present here. Feel free to suggest ideas and opinions.
π Steps to setup development environment Clone the repo git clone github.com/your_username/gitsetgo.git Open the folder in your favorite code editor and start adding modifications. π» Development guidelines Put all the code in one of the existing files in /src.
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.
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
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 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.
π¬ Owner
Garima Singh
Mrinal Kumar
built with love
β€οΈ Thanks to our awesome contributors.
β¨ Running it locally This project was bootstrapped with 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 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 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 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.
To learn React, check out the React documentation.
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
Project created by Garima Singh