🎉 Congratulations, your project was successfully generated with Create Next Stack!
To get started, run:
yarn devThere are a few final steps that we were not able to perform automatically. We have provided a complete list for you below. You should take care of these before you can start developing your project. You can delete each item from the list as you go along.
- Set up an account in Plausible Analytics, and add your website in their dashboard.
- Update the
NEXT_PUBLIC_WEBSITE_DOMAINenvironment variable to your website's domain to connect Plausible Analytics to your app. - Integrate Vercel with your repository host for continuous deployments at https://vercel.com/new
The table below provides names and descriptions of the npm scripts available in this project.
Each script is run using yarn <script-name>. For example: yarn dev.
| Name | Description |
|---|---|
test |
Runs tests |
dev |
Runs the Next.js development server. |
build |
Generates a production build. |
start |
Runs the Next.js production server built using build script. |
lint |
Runs ESLint to catch linting errors in the source code. |
format |
Formats all source code in the project. |
format:check |
Checks the formatting of all code in the project. |
deploy:vercel |
Deploy a preview deployment to Vercel |
The table below provides names and descriptions of the environment variables used in this project.
| Name | Description |
|---|---|
NEXT_PUBLIC_WEBSITE_DOMAIN |
The domain of your website. Used by Plausible Analytics. |
The table below gives an overview of the technologies used in this project, as well as places to learn more about them.
| Name | Links |
|---|---|
| Next.js | Website - Docs - Learn Next.js - GitHub - Wikipedia |
| React | Website - Docs - GitHub - Wikipedia |
| TypeScript | Website - Docs - GitHub - Wikipedia |
| Tailwind CSS | Website - Docs - GitHub |
| Framer Motion | Website - Docs - GitHub |
| React Hook Form | Website - Docs - GitHub |
| React Query | Website - Docs - GitHub |
| React Icons | Website - GitHub |
| ESLint | Website - Configuration - Rules - GitHub |
| Prettier | Website - Docs - Options - GitHub |
| Yarn | Website - CLI Docs - GitHub |
| GitHub Actions | Website - Docs - Workflow syntax |
| Plausible Analytics | Website - Docs - GitHub |
| next-plausible | Website - GitHub |
| Vercel | Website - Docs - CLI Docs |