Skip to content

Latest commit

ย 

History

History
64 lines (39 loc) ยท 2.02 KB

File metadata and controls

64 lines (39 loc) ยท 2.02 KB

Qraft Website

Lint

Website for the Qraft software engineering company; powered by Next.js and Tailwind CSS.

Installation

You need node and we highly recommend installing it through a Version Manager, such as nvm. The following will install node LTS and npm

$ brew install nvm
$ nvm install --lts

yarn is needed to fetch JS dependencies. Use brew ๐Ÿบ to install it; use --ignore-dependencies to use node's version from nvm.

$ brew install yarn --ignore-dependencies

Install the Javascript dependencies

$ yarn install

Development

Run the project in development mode to start the development server ๐Ÿ‘จ๐Ÿปโ€๐Ÿญ

$ yarn dev

Open a new browser window on http://localhost:3000 to launch your app โ˜•๏ธ ๐Ÿ‘จ๐Ÿปโ€๐Ÿญ

Linting & Styling

Linting

The project is linted using TypeScript and Eslint.

Run the linter manually to check your changes if needed:

$ yarn lint

Continuous integration ๐Ÿค– will run the linter and fail the build if any error is found. ๐Ÿ‘ฎโ€โ™€๏ธ

Styling

Code style ๐Ÿ’… is enforced by Prettier code style: prettier

We rely on Prettier default settings, so no configuration file is needed/present.

Run prettier manually to format your files if needed:

$ yarn format

Continuous integration ๐Ÿค– will run the formatter and fail the build if any error is found. ๐Ÿ‘ฎโ€โ™€๏ธ