CJ-NOTE CLI

This is a command line interface that launches on command, an interactive development environment that enables the user to write and document Javascript code conveniently. The web app of this CLI can be found at CJ-Note Web

Table of contents

• CJ-NOTE CLI
  • Table of contents
  • Overview
    • Links
    • Installation and Setup Instructions
  • My process
    • Built with
  • Author

Overview

Links

• Repo: Github repo
• NPM: NPM package

Installation and Setup Instructions

Installation: Run npm install -g cjnote to install this package.

usage On successful installation, run cjnote serve to start up the application on port 4005. Please note that cjnote serve is the default command hence the command indicates the following:

• Default port becomes 4005 hence the app will start on that port i.e http://localhost:4005/
• Data will be stored as JSON format on file - note.js

To customize the port and/or filename, the following commands should be used instead:

• cjnote serve [filename] - for example, cjnote serve example.js will create and save data in specified file - example.js in the directory on default port 4005.
• cjnote serve --port [port] - for example, cjnote serve --port 4050 will start up the app on server http://localhost:4050/ but on store data in default file note.js
• cjnote serve [filename] --port [port] - cjnote serve example.js --port 4050 will start up the app on server http://localhost:4050/ and save data in specified file example.js

In the event that you do not wish to install this package generally, you may run the command npx cjnote serve to download and use the package instantly. Do note that the above rules on usage applies in this instance but the command starts with npx instead rather than the package name.

My process

Built with

• Semantic HTML5 markup
• Flexbox
• CSS - For styles
• React - JS library
• Typescript - Ensure JS type safety
• Esbuild - Code bundler and transpiler
• React Redux - React redux
• React MD Editor - React Markdown Editor
• Monaco-Editor - Code editor
• React-Resizable - Resize react components
• localforage - JS library for storage
• Commander - NodeJS CLI framework
• ExpressJS - NodeJS framework
• Http proxy middleware - NodeJS proxy middleware

Author

Chisom Ijeomah

• GitHub - chisomije92
• Twitter - @devManiac92