https://github.com/liammartens/ferryhq-engineer-test

https://github.com/liammartens/ferryhq-engineer-test

Last synced: 11 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/liammartens/ferryhq-engineer-test
• Owner: LiamMartens
• Created: 2024-01-13T15:50:56.000Z (12 months ago)
• Default Branch: main
• Last Pushed: 2024-01-14T23:18:02.000Z (12 months ago)
• Last Synced: 2024-10-18T16:14:26.089Z (2 months ago)
• Language: TypeScript
• Homepage: https://ferryhq-engineer-test.vercel.app
• Size: 607 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Setting up the project

## Setup summary

- The project is set-up using [Next.js](https://nextjs.org/) with the app router.

- The code is mainly written in [TypeScript](https://www.typescriptlang.org/).

- For styling, the default [PandaCSS](https://panda-css.com/) configuration is used.

- [Husky](https://typicode.github.io/husky/) is being used to run scripts on commit

- [ESLint](https://eslint.org/) is used to improve code quality

- [Prettier](https://prettier.io/) is used to ensure standardized formatting.  

  _Note: while ESLint can be used for formatting - it is not it's main purpose. Prettier is faster for formatting and deals with a different use case, which is why both are being utilized._

- [Storybook](https://storybook.js.org/) is used in conjunction with [Chromatic](https://www.chromatic.com/) for UI testing.

- [Vitest](https://vitest.dev/) is used for unit testing

## Installing dependencies

After cloning the repository you will need to install the dependencies. The project is configured to use [Bun](https://bun.sh/) as it's package manager. If you don't have Bun installed yet you can install it using the link.

Once you have bun available you can simply run `bun install`. This will:

1. Install the required npm dependencies

2. Install husky for Git hooks. (used for linting and formatting on commit)

## Configuring environment variables

You will need to configure the following environment variables as needed:

| Name | Description |

|----|----|

| `CHROMATIC_PROJECT_TOKEN` | Only required if you intend to publish to chromatic locally |

## Running the project

For UI development you can run `bun run storybook` to start the Storybook server. To run the project itself you will need to run `bun run dev`