Git Set Go Application
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'. 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.
🔆 Tech Stack
The project is created using create-react-app and based on React.js framework.
- 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.
How to run?
Clone the repository
git clone https://github.com/garimasingh128/gitsetgo
Change to the project directory
In the project directory, you can run:
npm install to install
node_modules. You may receive an error telling you
node_modules missing otherwise.
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 run-script build
Builds the app for production to the
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!
✨ 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
- Code Editor (Visual Studio Code, Sublime Text)
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:
Migrating from Rest API to GraphQL API:
Resources for Github APIs':
Resources for node.js:
Resources for Prettier.io used in the project
Resources to learn Git and Github:
A few guidelines for someone looking to contribute here:
If you're a beginner
Cloneyour fork on local machine.
- Make a new
- Checkout to the new branch with
git checkout <new_branch_name>
- Do the desired changes and
git commit -m '<a nice commit message here>'.
pushthe change to your fork on GitHub with
git push origin <your_branch_name>
- Make a
Pull Requestto the original repository, i.e. this one.
Some guidelines related to the code:
- Try to stick to the syntax style followed in the code. This will help everyone to understand your code.
- Make sure you put comments wherever necessary.
- Include a visual preview (a screenshot or a GIF?) for any visual design changes if possible.
If you want to add a new feature, feel free to do so! :D
Happy Contributing! ✌️