Skip to content

Commit b1e7687

Browse files
danikovadanikova
committed
Merge remote-tracking branch 'origin/HEAD'
2 parents 2876cee + 5dd1d26 commit b1e7687

File tree

2 files changed

+72
-53
lines changed

2 files changed

+72
-53
lines changed

‎LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2024 Kovacs Daniel
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md

+51-53
Original file line numberDiff line numberDiff line change
@@ -1,70 +1,68 @@
1-
# Getting Started with Create React App
1+
# Online CV
22

3-
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
3+
[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
4+
[![GitHub stars](https://img.shields.io/github/stars/danikova/online-cv)](https://github.com/danikova/online-cv/stargazers)
45

5-
## Available Scripts
6+
**Online CV** is a personal web-based resume designed specifically to showcase my professional background, skills, and achievements. This project serves as a modern, interactive, and easily accessible version of my curriculum vitae, providing a detailed overview of my career in a visually appealing format.
67

7-
In the project directory, you can run:
8+
## Table of Contents
89

9-
### `npm start`
10+
- [Project Overview](#project-overview)
11+
- [Features](#features)
12+
- [Technologies Used](#technologies-used)
13+
- [Installation](#installation)
14+
- [Usage](#usage)
15+
- [License](#license)
1016

11-
Runs the app in the development mode.\
12-
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
17+
## Project Overview
1318

14-
The page will reload if you make edits.\
15-
You will also see any lint errors in the console.
19+
This **Online CV** project is a custom-built digital resume created to present my professional journey, skills, and qualifications in a dynamic and engaging way. Unlike traditional CVs, this online version offers interactivity and is accessible across various devices, making it convenient for sharing and viewing by potential employers, colleagues, and professional networks.
1620

17-
### `npm test`
21+
## Features
1822

19-
Launches the test runner in the interactive watch mode.\
20-
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
23+
- **Personalized Layout**: A tailored design that reflects my personal brand and professional identity.
24+
- **Responsive Design**: The CV is fully responsive, ensuring it looks great on desktops, tablets, and smartphones.
25+
- **Dynamic Content**: The content is structured to highlight my most relevant skills, experiences, and achievements.
26+
- **Shareable Link**: Easily share the CV via a unique URL.
2127

22-
### `npm run build`
28+
## Technologies Used
2329

24-
Builds the app for production to the `build` folder.\
25-
It correctly bundles React in production mode and optimizes the build for the best performance.
30+
- **Frontend**: HTML, CSS, JavaScript
31+
- **Framework**: React.js
32+
- **Styling**: Tailwind CSS
33+
- **Build Tool**: Vite
34+
- **Deployment**: Netlify/GitHub Pages
2635

27-
The build is minified and the filenames include the hashes.\
28-
Your app is ready to be deployed!
36+
## Installation
2937

30-
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
38+
To view or modify the project locally, follow these steps:
3139

32-
### `npm run eject`
40+
1. **Clone the repository**:
41+
```bash
42+
git clone https://github.com/danikova/online-cv.git
43+
```
44+
2. **Navigate to the project directory**:
45+
```bash
46+
cd online-cv
47+
```
48+
3. **Install the required dependencies**:
49+
```bash
50+
npm install
51+
```
52+
4. **Run the application**:
53+
```bash
54+
npm run dev
55+
```
56+
5. **Access the application**:
57+
- The app should be running at `http://localhost:3000`.
3358

34-
**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
59+
## Usage
3560

36-
If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
61+
- **Personal Viewing**: The online CV is tailored for my use, allowing me to present my professional background effectively.
62+
- **Update Content**: To update or revise the CV content, modify the React components accordingly.
63+
- **Preview CV**: Use the live preview to see changes in real-time as the content is updated.
64+
- **Shareable**: A public link can be shared with others to provide easy access to my CV.
3765

38-
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
66+
## License
3967

40-
You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
41-
42-
## Learn More
43-
44-
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
45-
46-
To learn React, check out the [React documentation](https://reactjs.org/).
47-
48-
### Code Splitting
49-
50-
This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)
51-
52-
### Analyzing the Bundle Size
53-
54-
This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)
55-
56-
### Making a Progressive Web App
57-
58-
This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)
59-
60-
### Advanced Configuration
61-
62-
This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)
63-
64-
### Deployment
65-
66-
This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)
67-
68-
### `npm run build` fails to minify
69-
70-
This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)
68+
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.

0 commit comments

Comments
 (0)