Code Monkey home page Code Monkey logo

workshop-crafting-human-friendly-clis's Introduction

$ Crafting Human Friendly CLIs with Node.js Core โ–ˆ

A workshop by Simon Plenderleith & Kevin Cunningham.

Getting ready for the workshop

1. Required software

You'll need to have this software installed:

Check that you have the software versions installed that you need for this workshop by running these commands in your terminal:

# Check Node.js version.
node --version

# Check npm version.
npm --version

2. Clone this repository with Git

You'll need to have this repository cloned so you can work on the coding exercises during the workshop:

git clone https://github.com/simonplend/workshop-crafting-human-friendly-clis.git

If you want to commit and push your work to your own repository on GitHub, you can fork this repository, then clone your fork rather than this repository directly. If you do create a fork, you'll want to sync it with this repository at the start of the workshop.

3. Open your editor and terminal

There are coding exercises throughout this workshop. To make sure you're ready:

  • Open this project in your code editor.
  • Open a terminal window for running commands, and cd to the directory for this project.

You're now ready to get started! ๐Ÿš€

Workshop exercises

We're going to build a CLI tool with APIs that are available in Node.js core. This tool will allow us to input notes and store them as daily notes in Markdown files.

Create a skeleton CLI

You can generate a skeleton CLI by running the create-cli shell script in your terminal:

npm run create-cli

Run your CLI

npx takenote

๐Ÿ‘‰ Start the first exercise: 01 - Parsing arguments

workshop-crafting-human-friendly-clis's People

Contributors

simonplend avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.