diff --git a/README.md b/README.md index 96057bef0..ae7704e79 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ Please fork it and send us improvements! Read our [CONTRIBUTING.md](CONTRIBUTING 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. -## Running the app locally +## Running the entire app locally This is a static site with a build step, simply run `npm start`: @@ -19,6 +19,50 @@ npm install npm start ``` +## Installing and running individual nodeschool workshop packages + +Please refer to the [nodeschool site](http://nodeschool.io/#workshoppers) for detailed instructions. In short, there are two ways to install the workshop modules : + +- **Globally** (easiest) + + Depending on the npm version, `npm packages` get installed in different routes. To have access to them globally. Do + + `npm install -global package_name` or `npm install -g package_name` + + If you get a `permission denied` **error**. Run the previous command with `sudo`. + + `sudo npm install -g package_name` + + Now just run it by simply calling it. **For example :** + + `npm install -g javascripting` **(installs it)** + + ![install_module](/images/readme-images/install_module.png?raw=true) + + + `javascripting` **(runs it)** + + ![run_module](/images/readme-images/run_module.png?raw=true) +` + +- **Custom directory** (a bit more configuration) + +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 :** + +``` +~ mkdir -p node_school +cd node_school +npm install javascripting +``` + +From within the `node_school` directory now run `node_modules/learnyounode/bin/javascripting` to start it. + +This is because you need to run the executable from within the directory itself since it's not available globally in your `$PATH` + +Please refer to this [discussion](https://github.com/nodeschool/discussions/issues/1869) for more info. + + + ## Stickers, Badges and whatnots 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. diff --git a/images/readme-images/install_module.png b/images/readme-images/install_module.png new file mode 100644 index 000000000..385e201cd Binary files /dev/null and b/images/readme-images/install_module.png differ diff --git a/images/readme-images/run_module.png b/images/readme-images/run_module.png new file mode 100644 index 000000000..71ed6ecd8 Binary files /dev/null and b/images/readme-images/run_module.png differ