https://github.com/mehdikhoshnevisz/resume
Simple and minimal resume builder with react and typescript
https://github.com/mehdikhoshnevisz/resume
gh-pages react typescript
Last synced: 4 months ago
JSON representation
Simple and minimal resume builder with react and typescript
- Host: GitHub
- URL: https://github.com/mehdikhoshnevisz/resume
- Owner: MehdiKhoshnevisz
- License: mit
- Created: 2022-04-05T12:44:43.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-04-22T07:16:03.000Z (about 1 year ago)
- Last Synced: 2025-05-07T06:04:46.205Z (about 1 year ago)
- Topics: gh-pages, react, typescript
- Language: TypeScript
- Homepage: https://mehdikhoshnevisz.github.io/resume
- Size: 6.4 MB
- Stars: 33
- Watchers: 1
- Forks: 14
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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**](https://reactjs.org/) and [**Typescript language**](https://www.typescriptlang.org/)
# 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//```)
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](https://pages.github.com/) 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://.github.io/```\
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](https://www.buymeacoffee.com/imehdi) :)
# 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!