Create your free and open-source resume just by editing a JSON file!
This project was bootstraped by Reacjs library and Typescript language.
You should have installed nodejs, npm, and (of course) git on your machine.
title | version |
---|---|
node js | >= 12.0.0 |
npm | >= 4.0.0 |
git | latest |
NOTE: If you don't have nodejs and npm installed on your system, I recommend you install them with nvm(node version manager) on your system. You can download and install it simplicity from Google!.
- Fork this repo (by click on
Fork
button) - Clone your forked repo (
git clone https://github.com/<YOUR_GITHUB_ACCOUNT>/resume
) - Run command
npm install
- Create the translation file with the path
locales/en/translation.json
inpublic
directory. - Copy content of
sample.json
in thetranslation.json
then edit and save the file. - Run command
npm run deploy
to build and deploy it in your github page.
NOTE 1: You can run
npm start
after step 5 to see the preview in your localhost.
NOTE 2: Everytime you edit the
translation.json
file, You should deploy your changes withnpm run deploy
.
You can see your resume created by Github Page here: https://<YOUR_GITHUB_ACCOUNT>.github.io/resume
But before that you should create your github page by doing these steps (or see the screenshot below):
- Go to your repo settings (by click on Settings tab)
- Click on Pages tab in the left sidebar.
- Below the Source title, select
gh-pages
branch and save it. - Yayy! 🥳 Now you can see your online resume from the link.
If you like this project and want to support me to make more projects like this, you can support me with SOL coin.
my SOLANA wallet: 4BjqDB5hGmZVkiRuBa5JkhceLVaTokYg4Gqe4fkV6Lby
.
Also you can Buy Me a Coffee :)
If you want to contribute to the project and make it better follow these steps:
- Fork the repo on GitHub
- Clone the project to your own machine
- Commit changes to your own branch
- Push your work back up to your fork
- Submit a Pull request so that we can review your changes
NOTE: Be sure to merge the latest from "upstream" before making a pull request!