README.md

INVENTORY APP

This application was built as a requirement for an open internship position (Backend Developer) at . This application was submitted on May 18th, 2022 and will be simultaneously hosted on for convenience - Found Here. This README will provide further information on how to use this application, how this application was built and further information about the author

Table of Contents

Using this application 📝

Functionality 🦾🤖

Testing 🔬

Workflow

Author 🙋‍♂️

Built With 🏗️

USING THIS APPLICATION

1️⃣ Fork and clone this repo

2️⃣ Install gems locally via bundle install from CL

3️⃣ Reset database via rails db:{drop,create,migrate,seed} from CL

4️⃣ Start server via rails s from CL

5️⃣ Manuever the site as you wish

6️⃣ (Optional) Run bundle exec rspec from CL to run the entire test suite

7️⃣ (Optional) Run open/coverage index.html from CL to see coverage by line

FUNCTIONALITY

This application accomplishes the basic CRUD functionality

CREATE

READ

UPDATE

DESTROY

FUN TIP

Try entering blank information or other ways to break the application to see what happens ! 😜

DATABASE

This application uses a relational database. There are two tables in total - items and warehouse. Items belong to a warehouse while a warehouse has many items (one to many relationship). See below for a representation of the database schema :

TESTING

This application was thoroughly testing using Rspec, SimpleCov, Capybara and Shoulda Matchers. Test coverage was held in high priority and can be seen in detail by following the following steps:

1️⃣ Run bundle exec rspec from CL to run the entire test suite

2️⃣ Run open/coverage index.html from CL to see coverage by line

All testing files can be found the Spec folder displayed by the following file tree:

WORKFLOW

Professional work flow using and were replicated as closely as possible. Specific tools and aspects were used while building this application that lended to organization, communication and developer empathy.

GITHUB PROJECT BOARDS

LINKED ISSUES/PULL REQUESTS

AUTHOR

If any ideas for improvement, any errors are seen, or if you are interested in building something in the future, please feel free to contact me directly via any of the below avenues:

BUILT WITH

Ruby version 2.7.4

Rails version 5.2.7

Hosted on
Found Here

💎 Additional Gems 💎

Capybara | Shoulda Matchers | SimpleCov | Faker |