Skip to content

Commit 6d0ca0a

Browse files
Merge pull request #526 from dantesolis/feature/update-readme
Add instructions on how to install and run modules in README.md
2 parents b198c14 + 7b7494b commit 6d0ca0a

File tree

3 files changed

+45
-1
lines changed

3 files changed

+45
-1
lines changed

README.md

Lines changed: 45 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Please fork it and send us improvements! Read our [CONTRIBUTING.md](CONTRIBUTING
1010

1111
We ask that you make pull requests because changes to this repository will get deployed onto the live production site immediately and it's best if you get feedback on your pull request first before it goes live.
1212

13-
## Running the app locally
13+
## Running the entire app locally
1414

1515
This is a static site with a build step, simply run `npm start`:
1616

@@ -19,6 +19,50 @@ npm install
1919
npm start
2020
```
2121

22+
## Installing and running individual nodeschool workshop packages
23+
24+
Please refer to the [nodeschool site](http://nodeschool.io/#workshoppers) for detailed instructions. In short, there are two ways to install the workshop modules :
25+
26+
- **Globally** (easiest)
27+
28+
Depending on the npm version, `npm packages` get installed in different routes. To have access to them globally. Do
29+
30+
`npm install -global package_name` or `npm install -g package_name`
31+
32+
If you get a `permission denied` **error**. Run the previous command with `sudo`.
33+
34+
`sudo npm install -g package_name`
35+
36+
Now just run it by simply calling it. **For example :**
37+
38+
`npm install -g javascripting` **(installs it)**
39+
40+
![install_module](/images/readme-images/install_module.png?raw=true)
41+
42+
43+
`javascripting` **(runs it)**
44+
45+
![run_module](/images/readme-images/run_module.png?raw=true)
46+
`
47+
48+
- **Custom directory** (a bit more configuration)
49+
50+
If you would like to keep all the node_school workshop packages inside a custom directory while you work through them. **Using our previous example :**
51+
52+
```
53+
~ mkdir -p node_school
54+
cd node_school
55+
npm install javascripting
56+
```
57+
58+
From within the `node_school` directory now run `node_modules/learnyounode/bin/javascripting` to start it.
59+
60+
This is because you need to run the executable from within the directory itself since it's not available globally in your `$PATH`
61+
62+
Please refer to this [discussion](https://github.com/nodeschool/discussions/issues/1869) for more info.
63+
64+
65+
2266
## Stickers, Badges and whatnots
2367

2468
These are in the `/images` directory, feel free to use for your events. In `images/make-a-sticker` there is a template for making a sticker too. Woop.
58.4 KB
Loading
50.7 KB
Loading

0 commit comments

Comments
 (0)