Skip to content

Latest commit

 

History

History
70 lines (55 loc) · 2.04 KB

README.md

File metadata and controls

70 lines (55 loc) · 2.04 KB

MRN-template 🦄

Next JS TypeScript React Mantine

This is a Next.js project using React and the Mantine UI library.

Screenshot of website

Live Preview ▶

Features

  • Mantine (v7), including the forms management library and the dates package
  • React (v18)
  • Tabler icons (v2)

Installation

Install the template:

git clone [email protected]:creme332/react-next-template.git

🔴 Note: Delete the .git folder in the root directory of this project if you are cloning this project inside another git folder.

Install dependencies:

npm install

To run the development server:

npm run dev

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

To run production server:

npm run start

Updating packages

To check for outdated packages:

npm outdated

To update all dependencies, if you are confident this is desirable:

npm update --save

🟢 Note: To migrate packages to newer versions, always refer to the documentation.

To-do

After installing the project, perform the following actions:

  • Update project title in package.json and package-lock.json
  • Ensure that you have the necessary VSCode extensions
  • Remove any unused dependencies
  • Update favicon in _app.tsx
  • Update website title and meta description in _app.tsx
  • Update font
  • Update logo in _app.tsx
  • Run lighthouse report
  • Use NextJS Link component instead of anchor tag

References