Me is an application which processes a JSON file with a specified schema and will generate a printer-friendly webpage as a result.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
-
Make a fork from this repository.
-
Clone your fork using following command:
git clone [YOUR-FORK-URL]
-
Go to Me directory and install dependencies:
cd ./Me yarn install
-
Modify your resume file which is located at
src/data/resume.json
-
Build your PDF resume in
/build/
directoryyarn run build
- Make sure you've installed Me step by step
- Run following command to test if the app works properly:
yarn test
- Node.js - Javascript Engine
- Create React App - React App Generator
- Yarn - Dependency Management
- SASS - CSS Preprocessor
- FontAwesome - Font Icons
- PurpleBooth's README Template - README Template
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
I use SemVer for versioning. For the versions available, see the tags on this repository.
- Alireza Sheikholmolouki - Initial work - Alireza29675
See also the list of contributors who participated in this project.
This project is licensed under the BSD 3-Clause License - see the LICENSE file for details