You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.project.md
+8-6Lines changed: 8 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,14 +6,17 @@ This is a starter app for [Next.js](https://nextjs.org/) (bootstrapped with [`cr
6
6
*[ESLint](https://eslint.org/)
7
7
*[Prettier](https://prettier.io/)
8
8
9
-
Note that Next v11 comes with the following installed already:
9
+
Note that Next v13 comes with the following installed already:
10
10
*[Webpack v5](https://webpack.js.org/concepts/)
11
-
*[Babel v7](https://babeljs.io/docs/en/)
12
11
13
12
## Getting Started
14
13
15
14
## Initial Setup
16
15
16
+
1. Setup [husky](https://typicode.github.io/husky/#/) by installing it at the base of the repo.
17
+
```bash
18
+
npm ci
19
+
```
17
20
18
21
1. Go to the `services/app` directory.
19
22
```bash
@@ -39,7 +42,7 @@ Note that Next v11 comes with the following installed already:
39
42
1. Now you are ready to start up the app. To do that, run `ddev start` from within the `services/app` directory:
40
43
```bash
41
44
ddev start
42
-
```
45
+
```
43
46
44
47
## Starting and stopping the project
45
48
@@ -148,16 +151,15 @@ with the option to include a Storybook story file as well.
148
151
## Notes
149
152
150
153
* Code for the app is currently configured to go into the `pages` directory (for [Next.js pages](https://nextjs.org/docs/basic-features/pages)) and `source`for theming, components, providers, helpers, etc.
151
-
* Starting in Next.js v9.4, TypeScript errors do not show up in your browser when running the dev server (i.e. `npm run dev`). However, TS errors will prevent `next build` (i.e. `npm run build`) from running successfully. Be sure to run `npm run lint` and `npm run tsc` before committing and pushing code. This will give you lint and TS errors that will most likely cause your builds to fail.
152
-
* For discussion: should we include a [TS checker in the config](https://github.com/vercel/next.js/issues/12735#issuecomment-629404102)? Note that a Next.js dev warns that [this will greatly slow development](https://github.com/vercel/next.js/issues/12735#issuecomment-629404842).
154
+
* Starting in Next.js v9.4, TypeScript errors do not show up in your browser when running the dev server (i.e. `npm run dev`). However, TS errors will prevent `next build` (i.e. `npm run build`) from running successfully. You can run `npm run lint` and `npm run tsc` to check for issues, which will give you lint and TS errors that will most likely cause your builds to fail. Note also that if you have [`husky`](https://typicode.github.io/husky/#/) installed, these will automatically run when you attempt to commit to a branch.
153
155
* The current favicon implementation will probably not display correctly locally in Chrome (v94), but does display correctly in Firefox and Safari. Note that the favicon _does_ display correctly once deployed. Not sure why.
154
156
155
157
156
158
## Helpful tips
157
159
158
160
### Starting project is slow
159
161
160
-
If the npm install is running slow you can enable`mutagen`, to do this:
162
+
If the npm install is running slow you can enable`mutagen`, to do this:
161
163
* In the `.ddev` folder create a file named: `config.mutagen.yaml`
0 commit comments