README.md

📓 NextJs Typescript SWC Boilerplate

Nextjs - Typescript - Styled-Components - SWC - Jest | testing-library - Storybook - Github Actions - Eslint - Prettier

🎉 Getting Started

These instructions will get you a comfy and solid start for your project.

Prerequisites

You will need to have:

npm (Node Package Manager)

Installing

How to start your project: Use as a template (recommended) | Download | Pull | Fork this repo.

Then install dependencies.

npm i

Now you have all devDependencies and dependencies the project need.

🏃 Run the project

Put your github account on CODEOWNERS file inside .github folder. You can edit or delete the config of ./.github/workflows in case you want your own configuration or you don't want it one.

For development run

npm run dev

For storybook run

npm run storybook

For tests run

npm run test