Skip to content
/ trellis Public

This is a simple Trello clone for me to tinker with in my free time. https://hooskers.github.io/trellis

License

Notifications You must be signed in to change notification settings

wadjoh/trellis

Repository files navigation

Trellis

This is a simple Trello clone for me to tinker with in my free time.

Pardon my dust

This is just a free time project that I work on for enjoyment and is not 100% complete.... only like 90% complete! There are still some styles and Jest tests to be added, but the basic feature set is there.

Tech

Usage

When you first load Trellis you are presented with the board list with one default board. You can:

  • Enter a name into the input at the top to add a new board.
  • The edit button of the board will allow you to change the board's background (custom solid colors coming soon, sorry!) and also change the board's name and delete it.
  • View a oard by clicking on its banner.

In the board you can:

  • Add a list by clicking the + symbol in the top right and entering a name for your new list.
  • Delete a list by clicking the trashcan icon in the top right and confirming the delete.
  • Rearrange the order of the lists with the mouse by dragging the list by its title bar and dropping it somewhere else on the board. Or you can also achieve the same thing with keyboard by giving the title bar of the list focus, pressing space to lift the list, using the arrow keys to shift it, and the spacebar to drop it in its new position. (Thanks React Beautiful DnD!)

In the lists are cards you can:

  • add a new card to a list by clicking the Add a card button at the top of the list and entering in a name and description for the card.
  • "Done" a card by clicking the checkmark in the bottom left.
  • Delete a card: click the trashcan icon in the bottom right.
  • Rearrange the cards in a similar fashion to lists by using the mouse or keyboard. You can put the card in a new position in the same list, or transfer it to another list in the board.

Development

To develop with Trellis just download the repo install the Yarn packages:

$ yarn

To start a live reload Webpack dev server run:

$ yarn start

To build the production version of Trellis which gets outputted to the docs directory (for GitHub Pages) run:

$ yarn build

It helps to develop components with Storybook and a live Storybook server can be started with:

$ yarn storybook

Tests can be run with:

$ yarn test

or to run the tests after a change:

$ yarn test:watch

About

This is a simple Trello clone for me to tinker with in my free time. https://hooskers.github.io/trellis

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages