Git Product home page Git Product logo

lcdscreen's Introduction

LCD screen

this project goal is to show number to a LCD screen

Build Status

(this is a example)

  • Build Status

Getting Started

These instructions will get a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

You will need to install the following software:

  • Docker Engine >= 18.06.1-ce
  • node >= 10.13.0 (chose a LTS version for production)
  • npm >= 5.0.0

Installing

A step by step that indicates how to get a development env running

git clone [email protected]:Nas84/lcdscreen.git

Then in the folder type

# Install dependencies
npm install

Running the tests

We have several type of tests. The framework we used is Jest.

here the command for running all of our unit tests

# Run the test
npm test

if you need to run only a sub domain you can type

# Run the test
npm test -- <pattern>

See details

Executing the CLI

In as bash shell, at the root of the folder type:

#run the cli
./bin/lcdscreen.js -s <number>

or you could do:

#run the cli
node ./bin/lcdscreen.js -s <number>

Break down into systems tests

the system test executes the command from a shell. We so, use a shell test framework for executing the command cli as an user/jenkins will do.

First install it, download the file “shunit2” zip and put it on your PATH somewhere. Then launch it by:

chmod +x ./test/system/sys_tests.sh
./test/system/sys_tests.sh

Built With

Our stack is build with :

  • nodeJs - The framework engine
  • Npm - Dependency Management
  • Jest - Testing framework for unit and integration
  • Shunit2 - Testing framework for system testing
  • Docker - The deployment and runtime technology

Contributing

Please read CONTRIBUTING.md for details on how to support the project, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the releases on this repository.

Authors

  • Nasser Srairi -

lcdscreen's People

Contributors

nas84 avatar bipbip38 avatar

Watchers

James Cloos avatar

Forkers

bipbip38

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.