README.md

Timeliner

Timeliner is an open-source, free to use web application that aims to help web developers and designers create a good-looking portfolio page, quick and easy.

Use Case

You need a portfolio or just a unique online resume, you need to add some basic information about yourself and what you do. You need it to look good, you don't have time to build it from scratch, and you don't want to buy a template for $10 and hack into it because again you don't have time for that, and you don't want to pay for a fancy online service.

Demo

TBC

Installation

1. Fork the app
2. Run bundle install in the root directory
3. Make sure that Postgresql is installed and you have an account setup
4. Create config\database.yml and fill it, you can see the sample file config\database.sample.yml for reference.
5. Create config\application.yml and fill it, you can see the sample file config\application.sample.yml for reference.
6. Run rake db:create db:migrte

Coding Style Guides

Ruby

• Ruby coding style guide

Rails

• Ruby on Rails 4 style guide

Front-end

• Code Guide
• Sass Guidelines

TODO

• Refactor code to follow the coding style guides.

Contributing

1. Fork it
2. Set it up
3. Create your feature branch (git checkout -b new-feature)
4. Commit your changes (git commit -am 'Add some feature')
5. Push to the branch (git push -u origin new-feature)
6. Create a new Pull Request

Sponsored by

Thanks to

• DigitalOcean for hosting
• AppSignal for providing error tracking & performance insight

you guys rock!