https://github.com/lmammino/streams-workshop
A FREE and open-source workshop about Node.js Streams
https://github.com/lmammino/streams-workshop
exercises learning node nodejs streams tutorial workshop
Last synced: 2 months ago
JSON representation
A FREE and open-source workshop about Node.js Streams
- Host: GitHub
- URL: https://github.com/lmammino/streams-workshop
- Owner: lmammino
- License: mit
- Created: 2019-05-28T20:25:11.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-05-04T20:01:43.000Z (about 1 year ago)
- Last Synced: 2025-03-30T09:07:51.982Z (3 months ago)
- Topics: exercises, learning, node, nodejs, streams, tutorial, workshop
- Language: JavaScript
- Homepage: https://nodejsdesignpatterns.com
- Size: 7.7 MB
- Stars: 271
- Watchers: 6
- Forks: 33
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# streams-workshop
[](https://github.com/lmammino/streams-workshop/actions/workflows/node.js.yml)
A workshop on Node.js Streams by Luciano Mammino ([@loige](https://twitter.com/loige)). 🤓
> I also have a workshop about [JavaScript Iteration Protocols](https://github.com/lmammino/iteration-protocols-workshop).
## Prerequisites
Before getting started, make sure you have the following prerequisites in your system:
- Node.js 16.14+
- NPM 8.3+
- a text editor of your choice
- a bash-compatible shell (if you use Windows you can [install bash](https://www.windowscentral.com/how-install-bash-shell-command-line-windows-10) or use Docker, as [described below](#using-docker))
## Getting started
Clone the repository and run `npm install` to get all the necessary dependencies.
The workshop is divided in chapters and the first chapter starts at [`01-buffer-vs-stream`](01-buffer-vs-stream/README.md).
Every chapter will teach you a specific stream concept and offer you some examples and exercises to familiarize with that concept.
You will often find 2 different types of interactive actions:
- **🎭 PLAY** : commands or instructions you should spend some time with to get familiar with some concepts or APIs
- **🏹 Exercise**: when you have to use some of the concepts you just learned to solve a programming problem. Generally every exercise will have a test that you can run to validate your solution.
Enjoy! 🙃
[➡️ GET STARTED](01-buffer-vs-stream/README.md).
## Using Docker
If you prefer to keep your environment clean and use Docker, you should be able to spin un a workable environment with Docker Compose by running:
```bash
docker-compose run workspace
```
If you use Docker, `npm install` is automatically run for you every time you launch the container.
## Shameless plug 😇
If you like this piece of work, consider supporting me by getting a copy of [Node.js Design Patterns, Third Edition](https://www.nodejsdesignpatterns.com/), which also goes into great depth about Streams and related design patterns.
If you already have this book, **please consider writing a review** on Amazon, Packt, GoodReads or in any other review channel that you generally use. That would support us greatly 🙏.
## Contributing
In the spirit of Open Source, everyone is very welcome to contribute to this project.
You can contribute just by submitting bugs or suggesting improvements by
[opening an issue on GitHub](https://github.com/lmammino/streams-workshop/issues) or by [submitting a PR](https://github.com/lmammino/streams-workshop/pulls).
## License
Licensed under [MIT License](LICENSE). © Luciano Mammino.