Git Product home page Git Product logo

getitdonejs's Introduction

Purpose

A TODO list application written in vanilla Javascript.
Bundling via Webpack.
CSS via preprocessor - SASS
Documentation via jsdoc.
Testing via Jest.

Getting started

git clone https://github.com/paramagicdev/GetItDoneJS
cd GetItDoneJS
yarn install

Local development

yarn dev

Production build

yarn build

Running test suite

One time run

yarn test

Watch for changes

yarn test:watch

How everything works

Components

UI components are stored in the src/js/components file & are saved as *.comp.js

A typical component is created as follows:

import DomManipulator from '../utils/domManipulator.js';
import {Base} from './base.comp.js';

export const addItemForm = (props = {}) => {
  const _base = Base(props);
  const _baseProps = _base.getProps();

  // ...Your code here
};
```

## Checklist

- [x] Your ‘todos’ are going to be objects that you’ll want to dynamically create, which means either using factories or constructors/classes to generate them.
      <br><br>

- [x] Brainstorm what kind of properties your todo-items are going to have. At a minimum they should have a title, description, dueDate and priority. You might also want to include notes or even a checklist.
      <br><br>

- [x] Your todo list should have projects or separate lists of todos. When a user first opens the app, there should be some sort of ‘default’ project to which all of their todos are put. Users should be able to create new projects and choose which project their todos go into.
      <br><br>

- [x] You should separate your application logic (i.e. creating new todos, setting todos as complete, changing todo priority etc.) from the DOM-related stuff, so keep all of those things in separate modules.
      <br><br>

- The look of the User Interface is up to you, but it should be able to do the following:
  - [ ] view all projects
  - [ ] view all todos in each project (probably just the title and duedate.. perhaps changing color for different priorities)
  - [ ] expand a single todo to see/edit it’s details
  - [ ] delete a todo
        <br><br>
- For inspiration, check out the following great todo apps. (look at screenshots, watch their introduction videos etc.)
  - Todoist
  - Things
  - any.do
    <br><br>
- [ ] Use localStorage to save user’s projects and todos between sessions.<br>
- Since you are probably already using webpack, adding external libraries from npm is a cinch! You might want to consider using the following useful library in your code:
  - date-fns gives you a bunch of handy functions for formatting and manipulating dates and times.

getitdonejs's People

Contributors

konnorrogers avatar

Watchers

James Cloos avatar  avatar

getitdonejs's Issues

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.