Skip to content

Latest commit

 

History

History
178 lines (133 loc) · 5.37 KB

README.md

File metadata and controls

178 lines (133 loc) · 5.37 KB

Forks Stargazers Issues MIT License


Logo

Screener Kanban Project

basic kanban
Explore the docs »

View Demo · Report Bug · Request Feature

About The Project

Product Name Screen Shot

Building a basic kanban style board.

(back to top)

Built With

  • React
  • CreateReactApp
  • Vercel

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Installation

  1. Clone the repo
    git clone https://github.com/mwmerz/kanban-project.git
  2. Install NPM packages
    yarn install
  3. Run it
    yarn start

(back to top)

Roadmap

Required Features

  • Basics
    • React
    • SPA
    • Boiler Plate
  • Model: Column
    • Name
    • Order
  • Model: Card
    • Name
    • Description
    • Created Date
    • Status
    • Order

User Stories

  • User can add column with name
  • User can modify column name
  • User can delete empty column
  • User can move columns by drag & drop
  • User can add card to column with name and description
  • User can modify card details
  • User can identify / switch status of card
  • User can move / order card by drag & drop
  • User can archive card

Advanced Features

  • Test codes
  • Graceful error handling
  • Multiple boards
  • More fields such as author, labels, assignee, comments, protected
  • i18n feature
  • Add to Homescreen with an icon
  • Persistent storage (by any method) to preserve state after refresh
  • Push notification when a new card created
  • Windowing list (react-window, react-virtualized) when rendering lots of cards
  • Code splitting and lazy loading
  • RWD(Responsive Web Design) for desktop/mobile
  • Show description when list is empty
  • 404 Page if url is not valid
  • Auto focus on initial state
  • Input Validation

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Michael Merz - @MichaelWMerz

Project Link: https://github.com/mwmerz/kanban-project

(back to top)