Giter Site home page Giter Site logo

bermarte / encapsulation-list-prototype Goto Github PK

View Code? Open in Web Editor NEW
0.0 3.0 2.0 388 KB

a minimalistic TODO app

Home Page: https://bermarte.github.io/encapsulation-list-prototype/public/

License: MIT License

JavaScript 93.60% HTML 0.83% CSS 5.57%
javascript todolist todoapp oop-principles encapsulation hyf

encapsulation-list-prototype's Introduction

Encapsulation-list-prototype

GitHub issues Website GitHub contributors

The Encapsulation-list-prototype is the last group project of the Encapsulation module. We will make a simple TODO app to practice Object Oriented JavaScript.

Group 5 is:


Group issue
Backlog
project-board
communication
discussion
Development strategy

figma file


FROM Encapsulation

Project

This week's project is to write a Encapsulation-list-prototype. You'll be given starter code with:

A suggested initial encapsulation for your encapsulation-prototype-list.

  • chai
  • deep-clone
  • describe it
  • gremlins
  • logger tool
  • reviews-button

The rest is up to you! Just be careful when scoping your project, it's better have a simple working than a complicated broken one.


This is the Encapsulation-list-prototype FROM HYF

collapse/expand

Getting Started

This repository comes with some nice extras like documentation, but in it's heart it's just an HTML/CSS/JS website boilerplate.

Development

To run this project locally you will need to open index.html in your browser using a local server. LiveServer, http-server, study-lenses, or any other local static server will work.

  • npm install
  • run study

Deployment

Push your changes, turn on GitHub pages, that's all!

When your project is deployed to GitHub pages there will be buttons rendered at the top of your page to validate your HTML, CSS, accessibility and spelling, plus a link back to the project repository.

Installing Dependencies

There are no dependencies needed to run the website, everything is prepared to work with vanilla JavaScript. However, if you want to run tests or if you want to generate documentation for your project you will need to install the development dependencies:

  • npm install

Documentation

To document your project you will need to write a JSDoc comment for each function in the /handlers, /listeners and /logic. You can also want to add an entry to the JSDoc in /data.js for each property you store in the object.

The JSDoc comments you write in the /src folder will be used to re-write the DOCS.md file each time you run npm run document from the root of your project.

Create the documentation (DOCS.md)
  • npm install
  • node ./lib/document.js

Testing

open public/test.html

Back to top

encapsulation-list-prototype's People

Contributors

22count22 avatar bermarte avatar colevanderswands avatar tahminarasoli avatar

Watchers

 avatar  avatar  avatar

encapsulation-list-prototype's Issues

refactor validator

rewrite the showAlert method of the Validator class and create the class instance.

unit-tests

  • include Chai and Mocha
  • create few unit - tests in todoTests.js
  • save results in test.html

Readme

  • assigning
  • shield.io
  • links

JsDoc

  • JSDoc documentation

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.