/examples

A repository of runnable Node.js examples that go beyond "hello, world!"

Primary LanguageJavaScriptMIT LicenseMIT

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 section below.

Here is an example of the structure in general terms:

- 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):

  • 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
    • 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 🤗

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 documentation for details on usage. See the emoji key for details on what each emoji represents.


Tierney Cyren
💻 🖋 📖 ⚠️
Matteo Collina
🚇 🤔
Thiru
💡 🚧