Skip to content

Commit 76d57bc

Browse files
RyanRyan
authored andcommitted
Updating files
1 parent aa0d671 commit 76d57bc

File tree

3 files changed

+28
-4
lines changed

3 files changed

+28
-4
lines changed

README.project.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,10 +58,10 @@ Note that these `ddev` commands _must_ be run in the `services/app` directory.
5858

5959
## Helpful commands
6060

61-
#### Monitoring the applications
61+
### Monitoring the applications
6262
If you want to monitor the status of `app` or `storybook`. Please use `ddev nextjs monit`
6363

64-
#### Restarting a specific service
64+
### Restarting a specific service
6565
If you want to restart `storybook` or `app`, please use the following:
6666

6767
`app`
@@ -151,3 +151,27 @@ with the option to include a Storybook story file as well.
151151
* 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.
152152
* 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).
153153
* 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+
155+
156+
## Helpful tips
157+
158+
### Starting project is slow
159+
160+
If the npm install is running slow you can enable `mutagen`, to do this:
161+
* In the `.ddev` folder create a file named: `config.mutagen.yaml`
162+
* In the file place: `mutagen_enabled: true`
163+
* Please Restart the project.
164+
**NOTE**: if you run into an issue with problems starting please run `ddev delete -O`.
165+
166+
### Installing npm packages within ddev
167+
168+
If you would want to use `npm`, please do `ddev npm [package]`.
169+
170+
### If the application never starts
171+
172+
To verify that it is working please run: `ddev nextjs monit` and if it is not working as expected please try the following:
173+
* Stop DDev, `ddev stop`
174+
* Remove `node_modules` folder from the `services/app`
175+
* Then restart DDev, `ddev start`
176+
177+

services/app/.ddev/config.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: [PROJECT NAME]
1+
name: test-project
22
type: php
33
docroot: public
44
php_version: "8.0"

services/app/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Forum One Next.js Starter App
1+
# Forum One Next.js Starter App to run locally without ddev
22

33
This is a starter app for [Next.js](https://nextjs.org/) (bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app)) that includes the following features:
44
* [TypeScript](https://www.typescriptlang.org/)

0 commit comments

Comments
 (0)