Table of Contents

1. About The Project
   • Build With
   • Gems Used
   • ER Diagram
2. Getting Started
   • Prerequisites
   • Installation
3. Usage

About The Project

This is a Rails CRUD application built out for practice purposes. CRUD operations are commonly used in web development and it stands for:

• Create
• Read
• Update
• Delete

Through developing this very simple, functional Buddies List application, I was trying to get a better understanding of Rails principles of the MVC architecture (Model-View-Controller pattern). For a demonstration, please refer to the Usage.

Build With

• Ruby
• Rails
• HTML
• Bootstrap
• PostgreSQL
  

Gems Used

• devise : Flexible authentication solution for Rails with Warden

• faker : Faker, a port of Data::Faker from Perl, is used to easily generate fake data: names, addresses, phone numbers, etc.

• pry-byebug : Combine 'pry' with 'byebug'. Adds 'step', 'next', 'finish', 'continue' and 'break' commands to control execution.

• rspec-rails : rspec-rails is a testing framework for Rails 5+.

• factory_bot_rails : factory_bot_rails provides integration between factory_bot and rails 5.0 or newer.

• pry-doc : Pry Doc is a Pry REPL plugin.

• better_errors : Provides a better error page for Rails and other Rack apps. Includes source code inspection, a live REPL and local/instance variable inspection for all stack frames.

  
  

Entity Relationship Diagram

back to top

Getting Started

Below are instructions on getting you a copy of the project up and running on your local machine for development purposes.

Prerequisites

• bundler

  gem install bundler

• yarn (it is recommended to install Yarn through the npm package manager)

  npm install --global yarn

  
  

Installation

1. Clone the repo

   git clone https://github.com/Ikko-T/buddies-list.git

2. Change the directory

   cd buddies-list

3. Install the dependencies specified in Gemfile

   bundle install

4. Create a database

   rails db:create

back to top

Usage

back to top