Skip to content

Commit 407c55e

Browse files
committed
reflected changes mentioned in review
1 parent 5f68cc6 commit 407c55e

File tree

1 file changed

+21
-17
lines changed

1 file changed

+21
-17
lines changed

README.md

+21-17
Original file line numberDiff line numberDiff line change
@@ -47,30 +47,37 @@ via lektor (see [Deployment](#deployment), below).
4747

4848
### Pre-Requisites
4949

50-
Make sure you have [pipenv][pipenvdocs], [Node.js][nodejswebsite] and [npm][npmdocs] installed. To install these, execute the following commands:
50+
Make sure you have:
51+
52+
* [pipenv][pipenvdocs]
53+
54+
* [Node.js][nodejswebsite] **v12+** and [npm][npmdocs] installed.
55+
56+
To install these, execute the following commands:
5157

5258
> For macOS:
59+
5360
1. `brew install pipenv`
5461
2. `brew install node`
5562

5663
> For GNU/Linux:
64+
5765
1. `curl https://raw.githubusercontent.com/kennethreitz/pipenv/master/get-pipenv.py | python`
5866
2. `sudo apt update`
59-
3. `sudo apt install nodejs`
60-
4. `sudo apt install npm `
67+
3. `curl -sL https://deb.nodesource.com/setup_lts.x | sudo -E bash -`
68+
4. `sudo apt-get install -y nodejs`
69+
5. `sudo apt install npm `
6170

6271
[pipenvdocs]:https://pipenv.readthedocs.io/en/latest/
6372
[nodejswebsite]:https://nodejs.org/en/
6473
[npmdocs]:https://docs.npmjs.com/
6574

66-
6775
### Installing Project Requirements
6876

6977
1. Clone this repository.
70-
2. Open your command line interface and `cd` to the repository root directory.
78+
2. Open your command line interface and `cd` to the repository's root directory.
7179
3. Run `pipenv install` to create a Python virtual environment and install the requirements for this project.
7280

73-
7481
### pipenv Troubleshooting
7582

7683
`pipenv` doesn't always provide the best error messages ([Provide better error
@@ -81,35 +88,32 @@ else fails, try removing the virtual environment and reinstalling:
8188

8289
[pipenverror]:https://github.com/pypa/pipenv/issues/1918
8390

84-
8591
## Development
8692

87-
- `cd` into `webpack`
88-
- Run `npm install` to install required node packages
8993
- Run `pipenv run lektor server -f webpack` to start the Lektor development
9094
server.
9195
- You will be able to see the website at [`http://localhost:5000/`][local5000].
9296
- The Lektor server will rebuild the site every time you change any content.
9397

9498
[local5000]:http://localhost:5000/
9599

96-
97100
### Troubleshooting Possible Errors
98101

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.
102+
Should you get series of type errors that looks something like `npm ERR! typeerror Error: Missing required argument #1`, after running `pipenv run lektor server -f webpack`, this is most likely due to running an older version of node.
100103

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+
As stated earlier in the prerequisites, you should be running Node versions 12+.
104105

105-
The solution is to run `sudo sysctl fs.inotify.max_user_watches=524288`
106+
* Follow [this](https://github.com/nodesource/distributions/blob/master/README.md#installation-instructions) tutorial to upgrade your node version (for GNU/Unix systems).
106107

107-
This increases your inotify watch limit to 524288, which is the maximum value.
108+
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.
108109

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+
The solution is to run:
110111

112+
* `sudo sysctl fs.inotify.max_user_watches=524288`
111113

114+
This increases your inotify watch limit (for the session) to 524288, which is the maximum value and is also enough to allow the setup go through.
112115

116+
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).
113117

114118
## Deployment
115119

0 commit comments

Comments
 (0)