Giter VIP home page Giter VIP logo

lab-configs's Introduction

LAB -

Project Name

Author: Student/Group Name

Mongo DB URL

mongodb://localhost:27017/

Common npm Scripts

"lint": "eslint "**/*.js"",
"start": "node index.js",
"test": "jest --verbose --coverage",
"test-watch": "jest --watchAll --verbose --coverage",
"jsdoc": "jsdoc -c ./docs/config/jsdoc.config.json",
"startDB": "mkdir -p ./.db && mongod --dbpath ./.db"

For JS DOCS

Leyla's Guide to JSDocs

  • for your server file: app.use('/docs', express.static('./docs'));

Links and Resources

Documentation

Modules

modulename.js

Exported Values and Methods
foo(thing) -> string

Usage Notes or examples

bar(array) -> array

Usage Notes or examples

Setup

.env requirements

  • PORT - Port Number
  • MONGODB_URI - URL to the running mongo instance/db

Running the app

  • npm start
  • Endpoint: /foo/bar/
    • Returns a JSON object with abc in it.
  • Endpoint: /bing/zing/
    • Returns a JSON object with xyz in it.

Tests

  • How do you run tests?
  • What assertions were made?
  • What assertions need to be / should be made?

UML

Link to an image of the UML for your application and response to events

lab-configs's People

Contributors

jessicakwalters avatar

Watchers

James Cloos 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.