Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
amadeuio committed Feb 22, 2024
1 parent d3e4fc4 commit bc919f6
Show file tree
Hide file tree
Showing 2 changed files with 76 additions and 2 deletions.
78 changes: 76 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,85 @@
![react](https://img.shields.io/badge/React-149eca)
![languages](https://img.shields.io/badge/languages-ts%2C%20html%2C%20css-blue)
![license](https://img.shields.io/badge/license-MIT-green)

# Make Your CV 📃"
# Make Your CV 📃

CV generation web app. Currently under development.
One page CV builder web app.

## Demo

<p align="center">
<img src="public/screenshots/screenshot.png" width="650px" alt="screenshot">
</p>
<h2 align="center">
<a href="https://amadeuio.github.io/make-your-cv">👉 Demo</a>
</h2>

## Features

User friendly and simple app.

- Simply enter your information on the forms and the CV will be updated in real time
- Expand each form to edit, collapse when desired
- Drag-and-drop the forms to organize cronologically
- Responsive: Enters 'Collaps Mode' on smaller screens
- Download the CV in PDF format

## Tech Stack

- **UI:** React
- **Languages:** TypeScript, CSS, HTML
- **Build Tool:** Vite
- **Dependencies:** react-beautiful-dnd, uuid, html2canvas, jspdf

## File Structure

- `/src`: Contains the source code

- `/src/components`: Individual UI components used throughout the application
- `/src/icons`: Components with SVG icons
- `/src/styles`: CSS styles
- `/src/App.tsx`: Main component responsible for managing state and rendering components of the whole application
- `/src/main.tsx`: Entry point for the React application
- `/src/initialData.tsx`: Initial placeholder data
- `/src/types.ts`: TypeScript type definitions for the data

- `/docs`: Distribution files generated during the build, GitHub pages is reading the root of this directory

- `index.html`: Entry point for the application

## Run Locally

Clone the project

```bash
git clone https://github.com/amadeuio/make-your-cv
```

Go to the project directory

```bash
cd make-your-cv
```

Install dependencies

```bash
npm install
```

Start the server

```bash
npm run dev
```

## Acknowledgements

- [Design inspo by Dmitry Sergushkin](https://dribbble.com/shots/20685447-Create-Event-Form)
- [GPT](https://chat.openai.com/)
- [shields.io](https://shields.io/)

## License

[MIT](https://choosealicense.com/licenses/mit/)
Binary file added public/screenshots/screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit bc919f6

Please sign in to comment.