Skip to content

Latest commit

 

History

History
124 lines (77 loc) · 6.64 KB

README.md

File metadata and controls

124 lines (77 loc) · 6.64 KB
Raw

Next.js 15 "Remix Contacts" Rebuild V2

This is a Next.js project bootstrapped with create-next-app.

It is a second rebuild of Remix Contacts using Next.js 15 with Server Actions, Tailwind CSS, and Prisma. It does not use a global transition handler anymore, but instead uses local transitions and useFormStatus. I have also improved the design, css and folder structure since V1.

See branches react-hook-form and react-query for modified app versions.

Requirements

  • Installed Node.js
  • Installed Visual Studio Code

Usage

First, force install the dependencies to make the React 19 Beta work:

npm install --force

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.

This project uses next/font to automatically optimize and load Inter, a custom Google Font.

Prisma Setup

Add a .env file to the root of the project, refer to .env.sample for the required environment variables. You need decide between prisma local development with sqlite or a real database with for example sqlserver. Define it in the schema.prisma file.

After switching, delete the prisma/migrations folder before running the migration command.

When using sqlserver, you need to migrate the database schema with:

npm run prisma.migrate

When using sqllite, initialize with:

npm run prisma.push

Seed prisma/seed.ts for initial data:

npm run prisma.seed

To view your data in the database, you can run:

npm run prisma.studio

Development Info

Development Tools

The project uses ESLint for linting and Prettier for code formatting. The configuration for these tools is located in .eslintrc.js and .prettierrc.js. The project is configured to run code formatting and linting on save in Visual Studio Code. Verify that code formatting and linting is executed on save as configured. Opening the .code-workspace file will ensure the correct extentions are set.

Naming Conventions

  • Pascal case for components
  • Kebab case for folders
  • Camel case for other files

Folder Structure

With Next.js, the folder structure is very important. The following folders are required:

  • public - contains the static assets of the application
  • / - contains the source code of the application
  • /app - contains the pages of the application using file based routing. Folders below this directory will be routes in the application unless they are prefixed with an underscore _ (ignore from routing) or grouped with parentheses () (ignore but keep subfolders in routing).
  • When using brackets [] in the name of a folder, the folder will be a dynamic route. The name of the folder will be the name of the parameter in the route.
  • For each route inside /app that is meant to be a route, there should be a page.tsx and alternatively layout.tsx for the route.
  • Each route can also have a error.tsx page for error handling, and a not-found.tsx page for handling 404 errors.
  • /components - contains shared components used across the application, same goes for the other folders in /.
  • /data - contains server-side data fetching and mutations.
  • For each route, _components can be used to store components that are only used in that route. Same goes for _hooks, _utils, etc. Every page folder should contain everything it needs to work. And every component or function should live at the nearest shared space in the hierarchy.

Refer to the Next.js App Router documentation for more information.

Routing

The project uses Next.js file-based routing. However, the route params and search params are not typed by default, so next-safe-navigation is used to type the route params and search params. This allows for type-safe navigation and query parameters. All routes are defined in /validations/routeSchema.ts and can be used by calling routes.<routeName>.

In client components, parsing params is done with the hooks useSafeParams and useSafeSearchParams. For server components, the pageProps are passed down as an unknown object and validated with routes.<routeName>.$parseParams and routes.<routeName>.$parseSearchParams.

Styling

The project uses Tailwind CSS for styling. Tailwind CSS is a utility-first CSS framework that allows you to rapidly build custom designs without leaving your HTML. The theme is configured in tailwind.config.js. Default styles are applied in /app/globals.css.

Use the cn util when merging conditional classes with other classes. Excess styling is applied in the components using Tailwind CSS utility classes. Tailwind also controls the responsive design of the application with a mobile-first approach. Refer to the Tailwind CSS documentation for more information.

Data Fetching and Mutation

The project uses Prisma for data fetching. Mutations are done using React Server Functions, skipping the Next.js 12 /api convention. Files are stores inside the src/data folder, where src/data/services are server-side data queries and src/data/actions are mutations. Take extra consideration when creating hidden endpoints with "use server" to avoid exposing sensitive data.

For more information, refer to the React Server Functions and Next.js Server Actions and Mutations documentation.

When using a form with an action, the loading state is included in the SubmitButton-component, and the form is disabled while the action is pending. For other cases, a loading state can be passed to to submit button or other components to handle the loading state.

Deployment

The app can be built for production using the npm run build command. The built files will be generated in the .next folder.

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.