Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sashkhen/shu-cv
Personal CV project
https://github.com/sashkhen/shu-cv
clsx css-modules css-variables cv dark-mode gh-pages media-queries momentjs react react-qr-code responsive typescript vite web
Last synced: 11 days ago
JSON representation
Personal CV project
- Host: GitHub
- URL: https://github.com/sashkhen/shu-cv
- Owner: sashkhen
- Created: 2024-11-08T16:44:44.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2024-12-11T03:00:42.000Z (13 days ago)
- Last Synced: 2024-12-11T03:29:38.109Z (13 days ago)
- Topics: clsx, css-modules, css-variables, cv, dark-mode, gh-pages, media-queries, momentjs, react, react-qr-code, responsive, typescript, vite, web
- Language: TypeScript
- Homepage: https://sashkhen.github.io/shu-cv/
- Size: 3.16 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# sashkhen's CV
Personal CV project. Webpage supports light and dark theme, it's responsive and print ready.
## Installation and usage
### Installing
In order to use this project you need to clone repo, install dependencies and start in dev mode
```bash
git clone https://github.com/sashkhen/shu-cv.git
cd shu-cv
npm i
npm run dev
```
### Updating
If you'd like to update CV with you own info, go to [data.json](./src/constants/data.json) file and make necessary adjustments.
In order to adjust print version sizing go to [global styles](./src/index.css) file and adjust base `font-size` value for `print` media query:
```css
...
@media print {
...
html {
font-size: 11.25px;
}
}
```
In order to update document title and favicon:
- go to [public folder](./public/) and replace existing logo files with your own
- go to [index.html](./index.html), update title, update favicon(s) `href` and `type` attributes
### Building
In order to build app for production use
```bash
npm run build
```
### Deployment
In order to deploy your own version of CV to github pages:
- make sure your project is on github ([changing a remote repository's URL](https://medium.com/@ninadkarlekar/deploying-your-react-project-on-github-pages-a-step-by-step-guide-f8b364fa75fa))
- update `package.json`
```json
{
"homepage": "https://.github.io/",
}
```
- commit and push changes
- run `gh-pages` scripts
```bash
npm run deploy
```
## Built with
### React + TypeScript + Vite
This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
Currently, two official plugins are available:
- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
#### Expanding the ESLint configuration
If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
- Configure the top-level `parserOptions` property like this:
```js
export default tseslint.config({
languageOptions: {
// other options...
parserOptions: {
project: ['./tsconfig.node.json', './tsconfig.app.json'],
tsconfigRootDir: import.meta.dirname,
},
},
})
```
- Replace `tseslint.configs.recommended` to `tseslint.configs.recommendedTypeChecked` or `tseslint.configs.strictTypeChecked`
- Optionally add `...tseslint.configs.stylisticTypeChecked`
- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and update the config:
```js
// eslint.config.js
import react from 'eslint-plugin-react'
export default tseslint.config({
// Set the react version
settings: { react: { version: '18.3' } },
plugins: {
// Add the react plugin
react,
},
rules: {
// other rules...
// Enable its recommended rules
...react.configs.recommended.rules,
...react.configs['jsx-runtime'].rules,
},
})
```