Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 31 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,39 +2,39 @@

The NextJS starter project will help developers quickly stand-up a website using NextJS and supporting technologies. The following documentation will guide you through the setup of NextJS and other technologies such as:

- Base
- Base

- NextJS
- TypeScript
- NextJS
- TypeScript

- UI
- UI

- MaterialUI
- MaterialUI

- Data
- Data

- Mobx
- useSwr
- Mobx
- useSwr

- Code Quality
- ESLint
- Prettier
- Husky
- Jest
- Code Quality
- ESLint
- Prettier
- Husky
- Jest

-Deployment

- server.js (assuming a deployment to Linux-based Azure Web App)
- server.js (assuming a deployment to Linux-based Azure Web App)

## **Additional features in this documentation:**

- Theming with Material UI
- Theming with Material UI

- Paging system in NextJS
- Paging system in NextJS

- Fetching data from a local API using SWR
- Fetching data from a local API using SWR

- Storing data in memory using mobx
- Storing data in memory using mobx

## Pre-requisites

Expand All @@ -61,12 +61,12 @@ Open package.json to see the following script:

These scripts refer to the different stages of developing an application:

- dev - Runs next dev which starts Next.js in development mode
- build - Runs next build which builds the application for production usage
- start - Runs build and then for starts production server
- lint - Runs lint which sets up Next.js' with custom built ESLint configuration
- prepare - Runs the prepare lifecycle before running the package to install the husky
- format - Runs command to formats all file supported by Prettier in the current directory and its subdirectories.
- dev - Runs next dev which starts Next.js in development mode
- build - Runs next build which builds the application for production usage
- start - Runs build and then for starts production server
- lint - Runs lint which sets up Next.js' with custom built ESLint configuration
- prepare - Runs the prepare lifecycle before running the package to install the husky
- format - Runs command to formats all file supported by Prettier in the current directory and its subdirectories.

## Pages

Expand Down Expand Up @@ -100,15 +100,15 @@ You will find the configuration file **.eslintrc.json** in the directory .

Here are some of the options that you can configure in ESLint:

- Environments - which environments your script is designed to run in. Here we see the env parameter that supports the required environments.
- Rules - Rules set the parameters that are followed by the company and at the required error level.
- Plugins - which third-party plugins define additional rules. environments etc. for ESLint to use.
- Environments - which environments your script is designed to run in. Here we see the env parameter that supports the required environments.
- Rules - Rules set the parameters that are followed by the company and at the required error level.
- Plugins - which third-party plugins define additional rules. environments etc. for ESLint to use.

Refer for more information to [https://eslint.org/docs/user-guide/configuring/]()

## **Other recommendations**

- Next-Js - [https://nextjs.org/docs/getting-started]()
- Prettier configuration - [https://prettier.io/docs/en/configuration.html]()
- Husky blog - [https://www.freecodecamp.org/news/how-to-add-commit-hooks-to-git-with-husky-to-automate-code-tasks/]()
- [A 2021 guide about structuring your Next.js project in a flexible and efficient way](https://dev.to/vadorequest/a-2021-guide-about-structuring-your-next-js-project-in-a-flexible-and-efficient-way-472)
- Next-Js - [https://nextjs.org/docs/getting-started]()
- Prettier configuration - [https://prettier.io/docs/en/configuration.html]()
- Husky blog - [https://www.freecodecamp.org/news/how-to-add-commit-hooks-to-git-with-husky-to-automate-code-tasks/]()
- [A 2021 guide about structuring your Next.js project in a flexible and efficient way](https://dev.to/vadorequest/a-2021-guide-about-structuring-your-next-js-project-in-a-flexible-and-efficient-way-472)
Loading