/happy_hour_journal

A Sinatra app to track the who/what/where of your happy hour adventures.

Primary LanguageRubyMIT LicenseMIT

Happy Hour Journal

Happy Hour Journal (HHJ) is journaling app to track the who/what/when/where of your happy hour adventures.

Installation

  1. Clone or download the repo: https://github.com/cyantis/happy_hour_journal

  2. In your terminal, navigate to the app's directory and execute:

    $ bundle install

to install dependencies.

  1. Launch a local server by executing:

    $ shotgun

and then visit http://localhost:9393in your browser to access the HHJ site.

To end the server session, type ctrl-c.

Usage

First time users will need to create (Signup) an account via a username, email, and password. Returning users log in via their username and password (Login).

Once logged in, a user's previous journal entries will be displayed. From this home page, the user can:

  1. Create a new journal entry by clicking Log a New Journal Entry.
  2. View a previous journal entry by clicking on the journal entry title (Location, Date).
  3. End the session by clicking Logout.

By visiting a previous journal entry page, the user can:

  1. Edit or Delete the entry
  2. Return to the home page (Home)
  3. Create a new entry (Log a New Journal Entry)
  4. Logout (Logout).

Whether creating or editing a journal entry, users always have the opportunity to Cancel any additions/changes.

Clicking Logout from anywhere in the app ends the user's session.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/cyantis/happy_hour_journal.

License

The gem is available as open source under the terms of the MIT License.