Nick Rook's Personal Website https://rooknj.com

Developing

Built With

• React
• Next.js

Prerequisites

• Nodejs v10.3 or later is required as this project uses Next.js (Check by running node -v)
• Yarn (Check by running yarn -v)

Setting up Dev

git clone https://github.com/Rooknj/personal-website.git
cd personal-website
yarn install
yarn start

Testing

Tests are written using Jest

Run tests once:

yarn test

Run tests on watch mode:

yarn test --watch

Run tests with coverage:

yarn test --coverage

Building

Create Production Bundle (outputs to /.next)

yarn build

Commit Messages

Commit messages must follow Conventional Commits

Example Messages

• chore(docs): updated Readme
• refactor: renamed X to Y
• fix(LightMessenger): fixed a bug where something wasn't working
• feat: Added ability to do cool new thing
• BREAKING CHANGE: Swapped database from Redis to Sqlite3

CI will fail if you do not use the correct commit format. Local messages are linted using Commitlint

Commitizen support coming soon

Versioning

I use SemVer 2.0.0 for versioning. To see available versions, check out the releases page

Style Guide

Linting

Linting is managed by ESLint

Run yarn lint to check all files

Currently we are extending my custom eslint config @rooknj/eslint-config

Any additional rules are added in .eslintrc.js

Note: The linter is ran during CI and the build will fail if there are any errors

Code Style

Code style is managed by Prettier

All default prettier styles are enabled except for the overrides located in .prettierrc.js

Prettier is automatically ran on staged files every commit using Husky and Lint-Staged

You can run prettier manually on every file through the command yarn format or you can set up prettier to run inside your IDE/Editor

License

This project is licensed under the terms of the MIT license.