Git Product home page Git Product logo

resume's Introduction

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) on your system. You can download and install it simplicity from Google!.


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 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 with npm run deploy.


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!

resume's People

Contributors

mehdikhoshnevisz avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.