reveurguy/nextjs-starter

Getting Started

First install the required packages by running:

npm install

Then, run the development server:

npm run dev
# or
yarn dev
# or
pnpm dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying app/page.tsx. The page auto-updates as you edit the file.

Project Technologies

Technologies used:

Nextjs
TailwindCSS
shadcn UI Library

This project uses TailwindCSS along with shadcn UI library. The libraay is installed and configured, you just need to start using the components.

shadcn UI Library Usage

Visit here to checkout the UI Library.

Run the command in the Installation section of a component to install it.
Read the Usage section to implement the component.

Commands to run before pushing code

After you commit all your changes, run these commands and commit the changes for these commands before pushing the code to the repository.

First Command

npm run format:write

This command formats the code properly with proper indentation and spacing so that the code is easier to read.

Second Command

npm run lint:fix

This command displays any errors in the code. After running this command, you will get a list of errors and warnings.
You can ignore the warnings, but if you get any error, it will provide the suggested fix for that error.
Then, fix the error and push your code finally!

Third Command

npm run typecheck

This command displays any issues (if present) within the code.

Updates

Whenever you push some major changes or fix any issue, mention the changes briefly in this section and also add the file name/path where the changes were made.

If this section has some updates written, don't clear them. Just add your changes after that.

Add points like this in a list format ( override this point to get started and add a - to make any point a list).

Learn More

To learn more about Next.js, take a look at the following resources:

Next.js Documentation - learn about Next.js features and API.
Learn Next.js - an interactive Next.js tutorial.

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.

reveurguy / nextjs-starter