GugWeb

Technology

• This is a Next.js project bootstrapped with create-next-app.
• Material-UI
• Material UI CSS in JS - JSS
• Project is using Prettier and ES-lint
• Use node 14.15.5 or compatible

Getting Started

Install by running:

yarn install
# or
yarn

then, run the development server:

yarn dev

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

Development

• Each page has its own file
• Use material-UI components as much as possible
• Use components as much as possible. Put them in /components directory
• Keep root layout in app.js
• JSS is compatible with SASS (Visual Studio has some nice plugins for it)
• Material-ui has a theme. Use it as much as possible

Git

• There is eslint and prettier before commit
• There is strict check before push (no errors, no warnings are allowed)
• use yarn lint-prod to see all errors and use yarn format to reformat and fix code
• use conventional commits if possible

Deploy

To get static web run:

yarn export

Deploy somewhere - TBD

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
• conventional commits - commit messages unification framework
• Materil-UI - react components, theme, layout, ...

Troubleshooting

0 days since last trouble