Skip to content

Latest commit

 

History

History
executable file
·
49 lines (34 loc) · 2.42 KB

README.md

File metadata and controls

executable file
·
49 lines (34 loc) · 2.42 KB
Raw

Inventorious

An inventory management and tracking system built with Ruby on Rails 5.

"Dashboard"

Demo: https://inventorious.herokuapp.com/

Description

Users (who have access to the app), can specify items, members (who can borrow items), and create borrow orders for members. Orders can then be marked as returned or canceled, or renewed for 7 days from a user. Only authenticated users can access the app and make changes. User registration is disabled. Emails to a specified address are sent when an order is created, deleted, renewed, or marked as "returned".

Installation Instructions

Install Rails

  • Make sure you have a Ruby version > 2.2.2 installed in your system
  • Install RubyGems
  • run gem install rails -v 5.0.2

Download Repo

  • Download this repo, and unzip it
  • cd inventorious to cd into the folder
  • bundle
  • rails db:migrate db:seed

Set Enviroment Variables

You need to set 6 enviroment variables, for emails to be delivered (for ActionMailer, password reset, etc).

You can use the Figaro Gem if you like.

Enviroment Variable Names Are
EMAIL_DOMAIN Domain of your email server
EMAIL_USERNAME Username for your email (most of the time [email protected])
EMAIL_PASSWORD Password for your email
SMTP_SERVER Address for your smtp server
EMAIL_SEND_FROM Email address where email will go out from
ACTION_MAILER_SEND_TO Email address which will receive email notifications on order create, cancel, renew, return

You may have to further configure the SMTP delivery options. If so, edit this file config/environments/development.rb

If you are deploying to Heroku, set HEROKU_URL as the url of your app!

Run the server

  • Run rails s to start the server
  • Without stoping the server, open another terminal window and run rake jobs:work (needed in order for ActionMailer to work and deliver emails)
  • Visit http://localhost:3000
  • Use [email protected] change_me for the email and password. Change the password and email once you login. Create more users via the Console.