Skip to content

Commit 5f68cc6

Browse files
committed
Improved project documentation
1 parent 1b7c961 commit 5f68cc6

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

+19
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,8 @@ else fails, try removing the virtual environment and reinstalling:
8484

8585
## Development
8686

87+
- `cd` into `webpack`
88+
- Run `npm install` to install required node packages
8789
- Run `pipenv run lektor server -f webpack` to start the Lektor development
8890
server.
8991
- You will be able to see the website at [`http://localhost:5000/`][local5000].
@@ -92,6 +94,23 @@ else fails, try removing the virtual environment and reinstalling:
9294
[local5000]:http://localhost:5000/
9395

9496

97+
### Troubleshooting Possible Errors
98+
99+
Should you get series of type errors that looks something like `npm ERR! typeerror Error: Missing required argument #1`, after running `npm install`, this is most likely due to running an older version of node.
100+
101+
From experience, running Node versions 12+ seems to be okay. Follow [this](https://github.com/nodesource/distributions/blob/master/README.md#installation-instructions) tutorial to upgrade your node version(for unix systems).
102+
103+
Should you get an `OSError: [Errno 28] inotify watch limit reached` after running any command, this means that your system file watcher is running out of alloted handles, usually because the workspace is large and contains many files.
104+
105+
The solution is to run `sudo sysctl fs.inotify.max_user_watches=524288`
106+
107+
This increases your inotify watch limit to 524288, which is the maximum value.
108+
109+
You can learn more about file watchers [here](https://unixia.wordpress.com/2018/04/28/inotify-watch-limit-reached-wait-what/) and [here](https://code.visualstudio.com/docs/setup/linux#_visual-studio-code-is-unable-to-watch-for-file-changes-in-this-large-workspace-error-enospc).
110+
111+
112+
113+
95114
## Deployment
96115

97116
We have continuous deployment set up. To deploy, push your code to the `master`

0 commit comments

Comments
 (0)