About This Project
Github Resume Generator
👣 Git Set Go
😃😃 A Github profile resume generator. ✨
👩 Demo PDF generated
DEMO - SS |
A Github Resume generator 👨💻👩 to create your own personalized resume based on your Github profile. 🔎 This tool lets you have your resume with 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
📋 Table of Contents
➡️ Vision
➡️ Tech Stack
➡️ Setup Development Environment
➡️ Future Plans
➡️ Contributing
➡️ Owner
👩 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 the 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 themaster
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:
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
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
❤️ 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
Thats it, By following all these steps your tool will be ready to use.