Skip to content

FoXZilla/short-night

Repository files navigation

Shot Night

The night is short, walk on girl.

https://short-night.pea3nut.org

🌳 An engine for drawing timeline graphs.

What is it?

An engine for drawing timeline graphs on canvas.

  • Minimal events data as input
  • Draws a timeline with axis, markers and event boxes
  • Fully customizable colors, styles, fonts
  • Time between events is directly proportional to distance on axis
  • Automatically handles overlap of event boxes on timeline

Use cases

  • Timeline of career events to put in a CV or resume to impress your employer
  • Timeline of past events in history
  • Share a task timeline of a project with a client

Demo

Check out a demo here

Develop

Want to contribute to this project? You're welcome!

Short Night is an engine, so it cannot produce a timeline on its own. If you want to make improvements to this engine, you have to develop alongside another project that uses Short Night.

You can check out polar-day for a minimal example.

  1. Start by forking and cloning short-night
  2. Clone polar-day
  3. Install dependencies on both repos
  4. Start building short-night in watch mode
cd /path/to/forked/short-night
npm run dev
  1. Create a symlink to short-night in polar-day for changes of short-night to take effect immediately.
cd /path/to/polar-day
npm link /path/to/forked/short-night/dist

Note: Notice the /dist at the end above. You must npm link to the dist folder for it to work.

  1. Develop and make changes in short-night and observe those changes by running polar-day

Wiki

Check out the wiki here to build your own timeline with customized colors and styles.