mirror of
https://github.com/AmruthPillai/Reactive-Resume.git
synced 2025-11-19 03:01:53 +10:00
Update README.md
This commit is contained in:
39
README.md
39
README.md
@ -38,13 +38,48 @@ You have complete control over what goes into your resume, how it looks, what co
|
|||||||
|
|
||||||
### Translation
|
### Translation
|
||||||
|
|
||||||
To translate the app, just fork the repository, go to `src/i18n/locales` and duplicate the `en.json` file to a new file `your-lang-code.json` and translate all of the strings inside. It's a simple process that would take just a few minutes, and by contributing, your name could also be added down below as a contributor!
|
To translate the app, just fork the repository, go to `src/i18n/locales` and duplicate the `en.json` file to a new file `your-lang-code.json` and translate all of the strings inside. It's a simple process that would take just a few minutes, and by contributing, your name could also be added down below as a contributor.
|
||||||
|
|
||||||
|
For those of you familiar with the Crowdin Platform, you could do that too and just head to http://crowdin.com/project/reactive-resume/ to translate the app over there. They have a great interface that helps you navigate through various strings and manage translations.
|
||||||
|
|
||||||
#### Languages Currently Supported
|
#### Languages Currently Supported
|
||||||
|
|
||||||
- English
|
- English
|
||||||
- Kannada (ಕನ್ನಡ)
|
- Kannada (ಕನ್ನಡ)
|
||||||
|
|
||||||
|
### Building from Source
|
||||||
|
|
||||||
|
Want to run your own instance of Reactive Resume? You are very much free to do so. The requirements to build from source are:
|
||||||
|
- NodeJS/NPM
|
||||||
|
- A Firebase Project
|
||||||
|
|
||||||
|
1. First, clone this project repository
|
||||||
|
```
|
||||||
|
git clone https://github.com/AmruthPillai/Reactive-Resume.git
|
||||||
|
cd Reactive-Resume
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Run npm install to install dependencies for the project
|
||||||
|
```
|
||||||
|
npm install
|
||||||
|
```
|
||||||
|
|
||||||
|
3. Create a `.env` file and fill it with your Firebase credentials
|
||||||
|
```
|
||||||
|
FIREBASE_APIKEY=""
|
||||||
|
FIREBASE_APPID=""
|
||||||
|
FIREBASE_AUTHDOMAIN=""
|
||||||
|
FIREBASE_DATABASEURL=""
|
||||||
|
FIREBASE_MEASUREMENTID=""
|
||||||
|
FIREBASE_MESSAGINGSENDERID=""
|
||||||
|
FIREBASE_PROJECTID=""
|
||||||
|
FIREBASE_STORAGEBUCKET=""
|
||||||
|
```
|
||||||
|
|
||||||
|
4. Run `npm run start` to run the development server or `npm run build` to build the production app.
|
||||||
|
|
||||||
|
And that's it! 🎉
|
||||||
|
|
||||||
### Donation
|
### Donation
|
||||||
|
|
||||||
I try to do what I can, but if you found the app helpful, or you're in a better position than the others who depend on this project for their first job, please consider donating as little as $5 to help keep the project alive :)
|
I try to do what I can, but if you found the app helpful, or you're in a better position than the others who depend on this project for their first job, please consider donating as little as $5 to help keep the project alive :)
|
||||||
@ -67,4 +102,4 @@ Thank you to everyone who made this project possible, including the many users w
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
###### Made with Love by [Amruth Pillai](https://amruthpillai.com/)
|
###### Made with Love by [Amruth Pillai](https://amruthpillai.com/)
|
||||||
|
|||||||
Reference in New Issue
Block a user