Skip to content

README-Template.md

Latest commit

 

History

History
111 lines (65 loc) · 510 KB

README-Template.md

File metadata and controls

111 lines (65 loc) · 510 KB
Raw

Project Title

Simple overview of use/purpose.

Description

An in-depth paragraph about your project and overview of use.

Getting Started

Dependencies

  • Describe any prerequisites, libraries, OS version, etc., needed before installing program.
  • ex. Windows 10

Installing

  • How/where to download your program

  • Any modifications needed to be made to files/folders

  • express is installed in the app’s root folder using…

npm install express
  • mongoDB is installed in the app’s root folder using…
npm install mongoDB
  • bootstrap is installed in the app’s root folder using…
npm install bootstrap

Example of an embedded images image_ref1

MicroCODE Symbol

Example of an embedded images image_ref2

MicroCODE Logo

Example of an embedded images [image_ref3]

![LADDERS Logo][image_ref3]

Executing program

  • How to run the program
  • Step-by-step bullets
code blocks for commands

Help

Any advise for common problems or issues.

command to run if program contains helper info

Terminology

Word or Acronym Description/Definition
API An Application Programming Interface, or API, is the set of functions/objects that a developer will provide in order to make use of their services.
ExpressJS Fast, unopinionated, minimalist web framework for Node.js
lowdb A JSON based (text) database.
NodeJS A development stack that executes from a local file store—on a local Server—instead of from a network of remote servers on the Web.
NPM Node Package Manager, actually “Node PM”, “Node pkgmakeinst” a system to deploy, install, and maintain NodeJS Apps. (PM was a BASH utility).

Authors

Contributors names and contact info

Version History

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

Inspiration, code snippets, etc.