docs(readme): update description, add sections to README.md
This commit is contained in:
Amruth Pillai
parent
2e288a5407
commit
fc29fb8eb4
43
README.md
43
README.md
|
|
@ -2,7 +2,9 @@
|
|||
|
||||
# Reactive Resume
|
||||
|
||||
### [Go to App](https://rxresu.me/) | [Sample Resume](https://google.com/)
|
||||
|
||||
|
||||
## [Go to App](https://beta.rxresu.me/)
|
||||
|
||||
Reactive Resume is a free and open source resume builder that’s built to make the mundane tasks of creating, updating and sharing your resume as easy as 1, 2, 3. With this app, you can create multiple resumes, share them with recruiters through a unique link and print as PDF, all for free, no advertisements, without losing the integrity and privacy of your data.
|
||||
|
||||
|
|
@ -14,11 +16,11 @@ You have complete control over what goes into your resume, how it looks, what co
|
|||
- No Advertising
|
||||
- No Tracking (no 🍪s too)
|
||||
- Sync your data across devices
|
||||
- Accessible in multiple languages
|
||||
- Import data from [LinkedIn](https://www.linkedin.com/), [JSON Resume](https://jsonresume.org/)
|
||||
- Manage multiple resumes with one account
|
||||
- Open Source (with large community support)
|
||||
- Send your resume to others with a unique sharable link
|
||||
- Accessible in multiple languages, [help translate here](https://translate.rxresu.me/)
|
||||
- Pick any font from [Google Fonts](https://fonts.google.com/) to use on your resume
|
||||
- Choose from 6 vibrant templates and more coming soon
|
||||
- Export your resume to JSON or PDF format with just one click
|
||||
|
|
@ -28,14 +30,28 @@ You have complete control over what goes into your resume, how it looks, what co
|
|||
- Tailor-made Backend and Database, isolated from Google, Amazon etc.
|
||||
- **Oh, and did I mention that it's free?**
|
||||
|
||||
## Docker
|
||||
## Docker Setup
|
||||
|
||||
You can pull the prebuilt docker images right off the shelf from either [Docker Hub](https://hub.docker.com/repository/docker/amruthpillai/reactive-resume) or [GitHub Container Registry](https://ghcr.io/amruthpillai/reactive-resume). Keep in mind, you would also need a database for this to work as intended.
|
||||
|
||||
```sh
|
||||
# Server
|
||||
docker run -p 3100:3100 --env-file .env amruthpillai/reactive-resume:server-latest
|
||||
|
||||
# Client
|
||||
docker run -p 3000:3000 --env-file .env amruthpillai/reactive-resume:client-latest
|
||||
```
|
||||
docker run -d -p 3000:3000 -p 3100:3100 --env-file .env amruthpillai/reactive-resume:v3
|
||||
|
||||
Or, to make your life easier there's a simple `docker-compose.yml` included to help you get set up for success.
|
||||
|
||||
```sh
|
||||
docker compose up
|
||||
```
|
||||
|
||||
## Build from Source
|
||||
|
||||
If you don't want to use Docker, I understand. There's an old-school way to build the app too. This project, and these instructions rely heavily on [pnpm](https://pnpm.io/) so you might want to have that installed on your system before you continue.
|
||||
|
||||
1. Clone the repository locally, or use GitHub Codespaces or CodeSandbox
|
||||
|
||||
```
|
||||
|
|
@ -43,22 +59,22 @@ git clone https://github.com/AmruthPillai/Reactive-Resume.git
|
|||
cd Reactive-Resume
|
||||
```
|
||||
|
||||
2. I prefer to use `pnpm`, but you can use anything to install dependencies (`npm`/`yarn`)
|
||||
2. Install dependencies using `pnpm`, but feel free to use any other package manager that supports npm workspaces.
|
||||
|
||||
```
|
||||
pnpm install
|
||||
```
|
||||
|
||||
3. Copy the `.env.example` file to `.env` in the project root and fill it with values according to your setup. Everything except the mail server settings are required.
|
||||
3. Copy the `.env.example` file to `.env` in the project root and fill it with values according to your setup. You can skip the SendGrid variables if you don't want to set up mail right away.
|
||||
|
||||
```
|
||||
cp .env.example .env
|
||||
```
|
||||
|
||||
4. Use Docker Compose to create a PostgreSQL instance and a `reactive_resume` database, or feel free to use your own and modify the variables used in `.env`
|
||||
1. Use Docker Compose to create a PostgreSQL instance and a `reactive_resume` database, or feel free to use your own and modify the variables used in `.env`
|
||||
|
||||
```
|
||||
docker-compose up -d
|
||||
docker-compose up -d postgres
|
||||
```
|
||||
|
||||
5. Run the project and start building!
|
||||
|
|
@ -70,6 +86,7 @@ pnpm dev
|
|||
## Contributing
|
||||
|
||||
Please refer to the project's style and contribution guidelines for submitting pull requests.
|
||||
|
||||
In general, this project follows the "fork-and-pull" Git workflow.
|
||||
|
||||
1. **Fork** the repo on GitHub
|
||||
|
|
@ -80,6 +97,16 @@ In general, this project follows the "fork-and-pull" Git workflow.
|
|||
|
||||
NOTE: Be sure to merge the latest from `main` before making a pull request!
|
||||
|
||||
## Bugs? Feature Requests?
|
||||
|
||||
Use the [GitHub Issues](https://github.com/AmruthPillai/Reactive-Resume/issues/new/choose) platform to notify me about bugs or new features that you would like to see in Reactive Resume. Please check before creating new issues as there might already be one.
|
||||
|
||||
## Donations
|
||||
|
||||
Reactive Resume would be nothing without the folks who supported me and kept the project alive in the beginning, and your cotinued support is what keeps me going. If you found Reactive Resume to be useful, helpful or just insightful and appreciate the effort I took to make the project, please consider donating as little or as much as your can.
|
||||
|
||||
[☕️ Buy me a coffee](https://www.buymeacoffee.com/AmruthPillai)
|
||||
|
||||
## License
|
||||
|
||||
Reactive Resume is packaged and distributed using the [MIT License](https://choosealicense.com/licenses/mit/) which allows for commercial use, distribution, modification and private use provided that all copies of the software contain the same license and copyright.
|
||||
|
|
|
|||
|
|
@ -1,33 +0,0 @@
|
|||
version: '3'
|
||||
|
||||
services:
|
||||
postgres:
|
||||
image: postgres
|
||||
container_name: postgres
|
||||
ports:
|
||||
- 5432:5432
|
||||
env_file: .env
|
||||
volumes:
|
||||
- ./scripts/database/initialize.sql:/docker-entrypoint-initdb.d/initialize.sql
|
||||
- pgdata:/var/lib/postgresql/data
|
||||
|
||||
server:
|
||||
image: amruthpillai/reactive-resume:server-latest
|
||||
container_name: server
|
||||
env_file: .env
|
||||
environment:
|
||||
- POSTGRES_HOST=postgres
|
||||
ports:
|
||||
- 3100:3100
|
||||
|
||||
client:
|
||||
image: amruthpillai/reactive-resume:client-latest
|
||||
container_name: client
|
||||
env_file: .env
|
||||
ports:
|
||||
- 3000:3000
|
||||
depends_on:
|
||||
- server
|
||||
|
||||
volumes:
|
||||
pgdata:
|
||||
|
|
@ -12,6 +12,10 @@ services:
|
|||
- pgdata:/var/lib/postgresql/data
|
||||
|
||||
server:
|
||||
# Production
|
||||
# image: amruthpillai/reactive-resume:server-latest
|
||||
|
||||
# Development
|
||||
build:
|
||||
context: .
|
||||
dockerfile: server/Dockerfile
|
||||
|
|
@ -25,6 +29,10 @@ services:
|
|||
- postgres
|
||||
|
||||
client:
|
||||
# Production
|
||||
# image: amruthpillai/reactive-resume:client-latest
|
||||
|
||||
# Development
|
||||
build:
|
||||
context: .
|
||||
dockerfile: client/Dockerfile
|
||||
|
|
|
|||
Loading…
Reference in New Issue