-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
76 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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/) |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.