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.

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!.

1. Fork this repo (by click on Fork button)
2. Clone your forked repo (git clone https://github.com/<YOUR_GITHUB_ACCOUNT>/resume)
3. Run command npm install
4. Create the translation file with the path locales/en/translation.json in public directory.
5. Copy content of sample.json in the translation.json then edit and save the file.
6. Run command npm run deploy to build and deploy it in your github page.

NOTE: You can run npm start after step 5 to see the preview in your local host.

NOTE: Everytime you edit the translation.json file, You should deploy your changes with npm 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):

1. Go to your repo settings (by click on Settings tab)
2. Click on Pages tab in the left sidebar.
3. Below the Source select gh-pages branch and save it.
4. 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 bitcoin.
my bitcoin wallet: bc1qxx8397gg9367n3lwft0pz70wgs8x9waehcy8lc.
Also you can Buy Me a Coffee :)

If you want to contribute to the project and make it better follow these steps:

1. Fork the repo on GitHub
2. Clone the project to your own machine
3. Commit changes to your own branch
4. Push your work back up to your fork
5. 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!