faouziMohamed / resume

Kutok CV

Build your static online resume by just adding your data to files validated by following schema defined on typescript interfaces.

how to use

Adding data

1. Star and Fork this repo
2. Edit files on src/data/resumeData folder to add your data to the resume. Each file represents a section of the resume.
3. Replace the image on public/images/userProfilePicture.jpeg folder with your own image.
4. Generate your favicon by using wesbsite like https://favicomatic.com/ or favicon.io and replace the files on public/images/favicon folder.

Run test to be sure your data is valid

Before running run

yarn lint:fix
yarn format:fix

Then run

yarn lint:strict
yarn format:check
yarn typecheck
yarn test

If you have any error, fix it and run the test again.

Building the resume

1. Install nodejs, yarn and typescript on your machine
2. Run yarn install to install dependencies
3. To test the resume locally run yarn dev
4. To build from nextjs to static files run yarn build
5. To serve the static files run yarn start

Deploying to Vercel (recommended)

1. Create an account on Vercel
2. Create a new project on vercel and connect it to your github account
3. Select the forked repo and deploy it
4. You can now access your resume on the url provided by vercel

License

MIT License (MIT) - see LICENSE for more details