mirror of
https://github.com/AmruthPillai/Reactive-Resume.git
synced 2025-11-13 00:03:27 +10:00
update readme.md, github main
This commit is contained in:
Amruth Pillai
83
README.md
83
README.md
@ -4,90 +4,11 @@
|
||||
|
||||
A one-of-a-kind resume builder that keeps your privacy in mind,
|
||||
completely secure, customizable, portable, open-source, and free forever.
|
||||
Try it out today!
|
||||
|
||||
**Visit https://rx-resume.web.app to build your resume!**
|
||||
|
||||
|
||||
|
||||
[](https://github.com/airbnb/javascript)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Do you have a demo?
|
||||
|
||||
Why yes, I do! Click the thumbnail below to watch the app in action.
|
||||
|
||||
[](http://www.youtube.com/watch?v=4OM0LEPzDO8 "Reactive Resume")
|
||||
|
||||
## What's so special about it?
|
||||
|
||||
| Feature | Description |
|
||||
| ------- | ----------- |
|
||||
| **Secure** | It is entirely secure, as in, your information never leaves the browser, powered by web technologies (HTML5 Local Storage API) that allow for data to be stored locally and quickly. |
|
||||
| **Offline** | The app is a PWA and also has no connection to any servers, thus keeping it entirely offline. It survives refreshes, disconnections, and can also be exported or imported through JSON. |
|
||||
| **Customizable** | Choose your fonts, play with the colors, pick any layout by merely enabling/disabling sections. A simple and easy to use interface that helps you get a resume in no time! |
|
||||
| **Templates** | I've been continuously designing new templates and will be releasing new ones as I have the time. Please support development by using the app and leaving a like/comment or sharing it with your peers. |
|
||||
| **Portable** | Your information can be exported to JSON and imported back into the application from anywhere, all you need is your JSON file. This feature makes it easy to update your resume, upload your file (or have it preloaded from local storage), edit the resume and download it again or print it as PDF. |
|
||||
| **Minimalistic Design** | As a designer, I felt I had to put this over the top of all other features. Built with minimalism and minimal interaction in mind, it looks clean, is simple to use, and I only hope to make the process more streamlined through your inputs and feedback. |
|
||||
| **Progressive Web App** | The web app is responsive, which means you can edit your resume on your phone as well and even install it as an app if you're on Android/Chrome. The app is quick to load and would also work if your internet is disconnected. |
|
||||
| **No Ads, Open Source, and Free** | As with all my projects, I made the app only to help others, so it will always remain free, and I would not be monetizing on it at any point. But if you do feel generous, I'm open to donations :) |
|
||||
|
||||
<p align="center">
|
||||
<img src="https://i.imgur.com/INN0f2Y.png" alt="Reactive Resume Thumbnail" width="600px" />
|
||||
</p>
|
||||
|
||||
## What did you use to build this?
|
||||
|
||||
* [ReactJS](https://reactjs.org/) + Hooks 🎉
|
||||
* [Tailwind CSS](https://tailwindcss.com/)
|
||||
* [Google Fonts](https://fonts.google.com/)
|
||||
* [Material Icons](https://material.io/resources/icons/)
|
||||
* [PostCSS](https://postcss.org/)
|
||||
* [PurgeCSS](https://purgecss.com/)
|
||||
|
||||
## How does it look?
|
||||
|
||||
<img src="https://i.imgur.com/Rv0IeWj.png" alt="Minimalistic UI" />
|
||||
|
||||
| | Feature | Cards | |
|
||||
| :---: | :---: | :---: | :---: |
|
||||
| <img src="https://i.imgur.com/jbTuaPA.png" alt="Tailor Made Templates" width="200px" /> | <img src="https://i.imgur.com/vPGMbAa.png" alt="Custom Color Options" width="200px" /> | <img src="https://i.imgur.com/7lO6WQr.png" alt="Custom Font Picker" width="200px" /> | <img src="https://i.imgur.com/8X1vdWf.png" alt="Exhaustive Sections" width="200px" /> |
|
||||
| <img src="https://i.imgur.com/R5vtxQ5.png" alt="Personalized in Every Way" width="200px" /> | <img src="https://i.imgur.com/EfdxUL7.png" alt="Quick Resume Updates" width="200px" /> | <img src="https://i.imgur.com/oQ6L1sM.png" alt="Save as PDF or Print Directly" width="200px" /> | <img src="https://i.imgur.com/u4DXkA9.png" alt="Secure, Offline & Portable" width="200px" /> |
|
||||
|
||||
## How can I contribute?
|
||||
|
||||
Right now, I don't have many avenues for quick and easy contribution. If you are well versed in React + Tailwind CSS, you can design a few templates yourself. Otherwise, the best way you can contribute is to **star the repository**, **share the app with your friends**, and if possible, **leave some feedback on the app** so that I can better improve it.
|
||||
|
||||
## How do I run the project source?
|
||||
|
||||
I'm glad you asked :) Here is a step-by-step procedure on getting you started with installation and deployment of the application.
|
||||
|
||||
1. Download & Install Node.js (https://nodejs.org/), make sure you can run `npm` in the command line
|
||||
2. `git clone https://github.com/AmruthPillai/Reactive-Resume.git`
|
||||
3. `cd Reactive-Resume`
|
||||
4. `npm install`
|
||||
5. `npm start` - to start the development server
|
||||
5. `npm run build` - to build a production version of the app
|
||||
|
||||
## What's changed since the release?
|
||||
|
||||
- Added Castform Template ([Preview](https://i.imgur.com/an0op8f.png))
|
||||
- Added Entry Animation to App
|
||||
- Added Languages & References Section
|
||||
- Updated Templates
|
||||
- Added Nunito Font
|
||||
- Fixed [Issue #2](https://github.com/AmruthPillai/Reactive-Resume/issues/2)
|
||||
- Added Markdown Support in Descriptions
|
||||
- Added Gengar Template
|
||||
|
||||
## Why did you make this free?
|
||||
|
||||
A lot of people have asked me for help in designing their resumes as I have made mine. I just wanted a more natural way to generate resumes and have it easy to update cause updating a resume is always the uphill task. Once I thought of the idea, it was only a matter of time to design and develop the app. I am a big supporter of the open-source development movement as I have been directly benefitted by so many other projects that developers have shared. So needless to say, this project is entirely open-source and free as well :)
|
||||
|
||||
Hope you enjoyed using the app, please let me know if you found it helpful.
|
||||
You can reach me on my website: https://www.amruthpillai.com/
|
||||
or by email: im.amruth@gmail.com
|
||||
|
||||
Thank you!
|
||||
### [Go to App](https://rxresu.me/) | [Documentation](https://docs.rxresu.me/)
|
||||
|
||||
Reference in New Issue
Block a user