JavaScript CSS HTML
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
build-tasks
src
test
.babelrc
.editorconfig
.gitignore
.travis.yml
CONTRIBUTING.md
ISSUE_TEMPLATE.md
LICENSE
LOG.md
PULL_REQUEST_TEMPLATE.md
README.md
gulp-config.js
gulpfile.js Address #57 Sep 16, 2016
package-lock.json
package.json
yarn.lock

README.md

Build Status tyto alt tag

tyto is an extensible and customizable management and organisation tool

just visit jh3y.github.io/tyto!

alt tag

Features

  • minimal UI
  • no accounts necessary
  • intuitive
  • extensible
  • localStorage persistence
  • time tracking
  • sortable UI
  • task linking
  • Markdown support
  • etc.

alt tag

Why tyto? What's it for?

Tyto arose from the want for an electronic post-it board without the need for accounts. Something simple and intuitive that could be easily shared.

It's also the product of my own curiosity being used as an opportunity to pick up new tech stacks. It started as a vanilla JS app utilising one file and experimenting with HTML5 drag and drop. It then grew a little more, and a little more after that. Now it uses Backbone w/ Marionette. The next step? Most likely Angular 2.0 or React.

alt tag

In truth, most organisations have some form of tool for what Tyto is doing. In my experience though, they can be cumbersome, clunky and just a bit noisy. Some employees tend to dislike internal tools. You still see whiteboards and walls plastered in sticky notes.

This is where Tyto came from, It's my personal intuitive and minimal TodoMVC. No accounts necessary and the source isn't too hard to grasp making it rather easy to extend and customise.

alt tag

Who's it for?

Developer and project managers were the original target audience. A means to share project progression on a more personal level. As opposed to publicly through an internal system. Almost like a complimentary attachment to an email.

alt tag

There are no restrictions though, it's open source. Not quite right out of the box? Change it 😄

Extensibility provides a means to create a bespoke version based on theme or functionality.

Tyto is a personal pet of mine and if it can help others, that's great!

###Using tyto Just want to use it? Do that by visiting jh3y.github.io/tyto.

GitHub flavored markdown is supported thanks to marked.

alt tag

This also enables you to link to boards, columns and other tasks by using the # character

alt tag

Changes are persistent thanks to localStorage.

Want to move to a different browser or machine though? Use the export utility to export a json file. Load this using the import utility.

A persistent workflow across devices? I'm afraid I haven't implemented that. Accounts is not something I am keen on implementing/hosting right now. I think it diverts from my original intention with Tyto.

Your own environment

Prerequisites

If you're cloning the repo and setting up the codebase you are going to need node(preferably yarn) and gulp installed.

Set up
  1. Clone the repo.

     git clone https://github.com/jh3y/tyto.git
    
  2. Navigate into the repo and install the dependencies.

     cd tyto
     yarn (alternatively, npm install)
    
  3. Run gulp to take care of preprocessing and running a local static server instance(project utilises BrowserSync).

     gulp
    

Hosting

I would suggest just taking a snapshot of the gh-pages branch and ftp'ing this onto your desired server or web space. Alternatively, follow the set up procedure and FTP the contents of the public directory.

If you wish to host on Github. Follow the set up procedure first(ideally, with a fork). When happy with your version, use the deploy task. This will require familiarity with gulp-gh-pages in order to publish to the correct location if other than gh-pages.

alt tag

Development

A strength of tyto is extensibility. Making changes whether it be functional or aesthetic is straightforward once familiar with the codebase.

Any queries as to how things work in the codebase? Feel free to raise an issue with a question!

alt tag

####Under the hood There are a range of technologies being used under the hood.

  • jQuery
  • jQuery UI
  • Material Design Lite
  • Lodash
  • Backbone
  • Marionette
  • Marked
  • Jade
  • Stylus
  • Babel
  • Gulp

alt tag

License

MIT


Made with @jh3y 2017