cv-react-ts-graphql

Source code for my online CV: React, TypeScript, and GraphQL

Overview

This codebase contains the source for my online CV: cv.mattcalthrop.com.

It uses the following features:

• React and TypeScript for building the UI
• Chakra for the design framework
• Contentful for hosting the content, and providing the GraphQL schema
• Yarn for dependency management
• ESLint for code linting
• Prettier for code formatting
• Husky to leverage git hooks
• GitHub Actions for CI workflow
• Netlify for deployment and hosting

You can fork this repo, and run it locally yourself. Following are instructions for setting it up and running it.

Setup

Install nvm

Follow instructions here:

github.com/nvm-sh/nvm

Then download and install the correct version of node:

nvm install

Install yarn

Follow the instructions here:

yarnpkg.com/en/docs/install

Install NodeJS packages

Install the NodeJS packages:

yarn

Running the app

During development

yarn start:dev

This will open a web browser at this URL:

http://localhost:5173/

Tests

All

To run all tests:

yarn test

Linting

Check .eslintrc.js for the eslint rules.

To run the linter:

yarn lint

And to auto-correct any errors that can be corrected:

yarn lint:fix

Code formatting

Check .prettierrc.json for the Prettier rules.

To check the TypeScript formatting:

yarn prettier

And to auto-correct any errors that can be corrected:

yarn prettier:fix

License

MIT