Simple and minimal resume builder 📄

Create your free and open-source resume just by editing a JSON file!
This project was bootstraped by Reacjs library and Typescript language

Requirements

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

How can I use it? (SETP by STEP)

1. Fork this repo (by click on Fork button)
2. Clone your forked repo (git clone https://github.com/<YOUR_GITHUB_ACCOUNT>/<YOUR_FORKED_REPO_NAME>)
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 on 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 with npm run deploy.

NOTE 3: If you lose your deployed JSON file in any case, you can easily find your JSON file in gh-pages branch and then locales folder in your repo.

Launch your resume 🚀

You should create your Github Page by doing these steps (or see the screenshot below):

1. Go to your repo settings (by clicking on Settings tab)
2. Click on Pages tab in the left sidebar.
3. Below the Source title, select gh-pages branch and save it.
4. Yayy!

Now you can see your online resume here: https://<YOUR_GITHUB_ACCOUNT>.github.io/<YOUR_FORKED_REPO_NAME>
For example: https://mehdikhoshnevisz.github.io/resume

Donation

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 :)

Contributing ✨

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!