Skip to content

Repository files navigation

README

Hello my name is Joe Chirum, I own Sun and Rain Works, and am a web developer and software engineer.

Friends App

This is a simple Ruby on Rails web application for managing a list of friends. It's built using:

  • Ruby on Rails (version [your Rails version])
  • Bootstrap 5
  • SQLite3 (development database)

Features

  • User Authentication: Secure user registration and login with Devise.
  • Friend Management:
    • Add new friends with their name, email, phone, and Twitter handle.
    • View a list of all friends.
    • Edit existing friend information.
    • Delete friends from the list.
  • Responsive Design: The application is built with Bootstrap 5 for a clean and responsive user interface across different devices.

Getting Started

Prerequisites

  • Ruby (version [your Ruby version])
  • Rails (version [your Rails version])
  • Node.js and Yarn (for JavaScript and CSS asset management)
  • SQLite3

Installation

  1. Clone the repository:

    
    git clone https://github.com/sundog358/rubyfriends.git
    Markdown:
    
    Navigate to the project directory:
    cd friends
    
    Bash:
    
    Install dependencies:
    bundle install
    yarn install
    
    Bash:
    
    Set up the database:
    rails db:create
    rails db:migrate
    
    Bash:
    
    Start the server:
    rails server
    
    Bash:
    
    Open the application in your browser:
    http://localhost:3000
    
    File Structure
    friends/
    ├── app/
    │   ├── assets/
    │   │   ├── config/
    │   │   │   └── manifest.js
    │   │   ├── images/
    │   │   │   ├── aibinarycodeart.jpg
    │   │   │   └── .keep
    │   │   └── stylesheets/
    │   │       ├── application.css
    │   │       └── custom.css
    │   ├── channels/
    │   ├── controllers/
    │   │   ├── concerns/
    │   │   │   └── .keep
    │   │   ├── application_controller.rb
    │   │   ├── friends_controller.rb
    │   │   └── home_controller.rb
    │   ├── helpers/
    │   │   ├── application_helper.rb
    │   │   ├── friends_helper.rb
    │   │   └── home_helper.rb
    │   ├── javascript/
    │   │   ├── controllers/
    │   │   │   ├── application.js
    │   │   │   ├── hello_controller.js
    │   │   │   └── index.js
    │   │   └── application.js
    │   ├── jobs/
    │   │   └── application_job.rb
    │   ├── mailers/
    │   │   └── application_mailer.rb
    │   ├── models/
    │   │   ├── concerns/
    │   │   │   └── .keep
    │   │   ├── application_record.rb
    │   │   ├── friend.rb
    │   │   └── user.rb
    │   └── views/
    │       ├── devise/
    │       │   ├── confirmations/
    │       │   ├── mailer/
    │       │   ├── passwords/
    │       │   ├── registrations/
    │       │   ├── sessions/
    │       │   ├── shared/
    │       │   └── unlocks/
    │       ├── friends/
    │       │   ├── _form.html.erb
    │       │   ├── _friend.html.erb
    │       │   ├── _friend.json.jbuilder
    │       │   ├── edit.html.erb
    │       │   ├── index.html.erb
    │       │   ├── index.json.jbuilder
    │       │   ├── new.html.erb
    │       │   ├── show.html.erb
    │       │   └── show.json.jbuilder
    │       ├── home/
    │       │   ├── _header.html.erb
    │       │   ├── about.html.erb
    │       │   └── index.html.erb
    │       └── layouts/
    │           ├── _alerts.html.erb
    │           ├── application.html.erb
    │           ├── mailer.html.erb
    │           └── mailer.text.erb
    ├── bin/
    ├── config/
    ├── db/
    │   ├── migrate/
    │   │   ├── 20240725081808_create_friends.rb
    │   │   ├── 20240726023213_devise_create_users.rb
    │   │   └── 20240726222452_add_user_id_to_friends.rb
    │   ├── schema.rb
    │   └── seeds.rb
    ├── lib/
    ├── log/
    ├── public/
    │   ├── 404.html
    │   ├── 422.html
    │   ├── 500.html
    │   ├── apple-touch-icon-precomposed.png
    │   ├── apple-touch-icon.png
    │   ├── favicon.ico
    │   └── robots.txt
    ├── storage/
    │   ├── development.sqlite3
    │   └── .keep
    ├── test/
    │   ├── channels/
    │   ├── controllers/
    │   ├── fixtures/
    │   ├── helpers/
    │   ├── integration/
    │   ├── mailers/
    │   ├── models/
    │   ├── system/
    │   ├── application_system_test_case.rb
    │   └── test_helper.rb
    ├── tmp/
    ├── vendor/
    ├── .dockerignore
    ├── .gitattributes
    ├── .gitignore
    ├── .ruby-version
    ├── config.ru
    ├── Dockerfile
    ├── Gemfile
    ├── Gemfile.lock
    ├── LICENSE
    ├── Rakefile
    └── README.md
    

About

ruby friends list demo app

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages