Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nodejs/examples
A repository of runnable Node.js examples that go beyond "hello, world!"
https://github.com/nodejs/examples
examples node nodejs
Last synced: about 1 month ago
JSON representation
A repository of runnable Node.js examples that go beyond "hello, world!"
- Host: GitHub
- URL: https://github.com/nodejs/examples
- Owner: nodejs
- License: mit
- Created: 2020-04-02T21:31:33.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-01-09T19:54:12.000Z (10 months ago)
- Last Synced: 2024-04-14T00:38:23.742Z (7 months ago)
- Topics: examples, node, nodejs
- Language: JavaScript
- Homepage:
- Size: 54.7 KB
- Stars: 565
- Watchers: 26
- Forks: 311
- Open Issues: 26
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
⚠️⚠️⚠️
The contents of this repository are not up to date.
The opinions and information expressed here do not necessarily reflect the up-to-date opinions of the Node.js project.
It is kept here as a public archive.
⚠️⚠️⚠️
-----
# Node.js Examples
This repository is a collective of opinionated and real-world examples of how you can use Node.js to build things.
## How This Repository is Structured
This repository is structured in a specific way:
- **Top-level directories** are **category directories** of applications - for example `CLI`, `server`, and `utility` - that enable you to find the specific _kind_ of example you're looking for.
- **Second-level directories** are **project directories** named after specific modules, frameworks, platforms, or tools - for example, `yargs` is a CLI framework, both `express` and `fastify` are web frameworks, and `moment` is a utility.
- **Third-level directories** are **example directories**, where specific examples live. You can find a full list of these examples in the [Examples](#examples) section below.
Here is an example of the structure in general terms:
```text
- examples (root)
- category
- project
- example
- category
- project
- example
- example
- example
- project
- example
- example
- category
- project
- example
- project
- example
- example
```
Each **example** has a few properties (if one doesn't, please [let us know](https://github.com/nodejs/examples/issues/new)):
- Usable example code.
- Passing tests.
- A README.md that explains what the example does and how to use it.
## Examples
### CLI
Command Line Interfaces (CLIs) are tools that can be accessed exclusively from the command line that generally serve some utility. There is a vibrant community of Node.js CLI utilities, ranging from packages to make it slightly easier to accomplish something to full frameworks for building CLI experiences.
- [CLI](./cli)
- [yargs](./cli/yargs)
- [countEntriesInDirectory](./cli/yargs/countEntriesInDirectory): A small command line tool that shows how to use yargs and Node.js together, leveraging Node.js's `path` and `fs` modules to read a directory passed by the CLI user
## Contributing
We've documented how to meaningfully contribute in [CONTRIBUTING.md](./CONTRIBUTING.md) 🤗
### Thank You To Our Contributors
> We use All Contributors for this section of the README. Please ensure you have the `all-contributors-cli` installed if you're modifying it. See the [All Contributors CLI Usage](https://allcontributors.org/docs/en/cli/usage) documentation for details on usage. See the [emoji key](https://allcontributors.org/docs/en/emoji-key) for details on what each emoji represents.
