Code Monkey home page Code Monkey logo

carson-bot's Introduction

Welcome to CarsonBot!

CarsonBot is a versatile home inventory management system built using Sinatra, ActiveRecord, ActiveSupport, bcrypt, and Rack Flash.

Installation

Run bundle install to install all required gems.

To Run Locally

Run shotgun in root directory. (Default port is 9393. Application will error if port is in use.)

Open browser and navigate to http://localhost:9393/. Application landing page will appear.

File Structure

config.ru - Specifies files to use and run.

/config - Contains environment.rb, which establishes database connection and contains custom ActiveSupport::Inflector specifications.

/app - Contains Sinatra MVC files for app.

/db - Contains database, migrations, and seeds.

/public - Contains custom CSS and UI assets.

Routes and Features

/ - Landing page, will direct you to log in or sign up.

/users - Shows the logged in user's home dashboard, with a summary of the user's available items and lists.

/locations - Shows all of a logged in user's items organized by location. Users can select one of the provided default locations (which are protected from editing) when creating a new item, or create their own custom location. Custom locations are automatically deleted when they have no items assigned to them.

/categories - Shows all of a logged in user's items organized by category. Users can select one of the provided default categories (which are protected from editing) when creating a new item, or create their own custom categories. Custom categories are automatically deleted when they have no items assigned to them.

/lists - Shows all lists belonging to a user. Users can create entirely customized lists, or automatically generate new lists from several default list type (e.g. "Shopping List"), which will auto-populate the list with items based on each item's stored data. Lists can be deleted by the user, and will also automatically be deleted when they have no list items assigned to them.

Disclaimer

Downton Abbey and the character of Carson the Butler are not my property. This is a non-profit student portfolio project and is in no way affiliated with the Downton Abbey TV show or its owners.

carson-bot's People

Contributors

chrissyhunt avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.