/ritchie-docs

This repository contains Ritchie CLI documentation ⚙️ 🖥 💡

Primary LanguageCSSApache License 2.0Apache-2.0

The Ritchie CLI project has been archived by Zup Innovation. It might start again eventually; however, we won't deliver support for now.

Ritchie CLI Documentation

This repository uses hugo server and contains Ritchie CLI official documentation.

Table of contents

1. About

2. Getting Started

1.1. Requirements

1.2. Installation

1.3. Build

3. Contributing Guide

4. Code of Conduct

5. Community

About

Ritchie CLI is an open source project that allows to create, store and share automations, executing them through command lines.

For more information, check out Ritchie's documentation.

Getting started

Requirements

To edit, run and build this project, you will need:

  • Yarn

    • To check the installation, run yarn -v in your terminal.

  • Node

    • To check the installation, run npm -v and node -v in your terminal.

  • Hugo

    • To check the installation, run hugo version in your terminal.

Installation

Run the command below to install the dependencies:

npm run dependencies

or

npm i && git submodule init && git submodule update

Build

Run the following command to build this project:

npm run build

And you can see the folder generated by hugo into ./dist path.

Running

To see this project running, use the command below:

hugo serve

or

npm start
  • Now, check if the Web Server is available at http://localhost:1313/docs/.

Running the website locally

Once you've cloned this repo, from the root folder, run the command:

hugo server

Contributing Guide

Check out Ritchie's contributing guide to contribute to our documentation.

Code of Conduct

Please read the code of conduct, you will be able to understand what actions will and will not be tolerated.

Community

If you have any questions or ideas, let's chat in our Zup Open Source Forum.

Ritchie Team