This app is the Apartment Department, used for finding a new apartment. The app has CRUD functionality and uses various elements to make UX and UI easy to understand.
$ rails new apartment-app -d postgresql -T
$ cd apartment-app
$ rails db:create
$ bundle add rspec-rails
$ rails generate rspec:install
$ bundle add webpacker
$ bundle add react-rails
$ rails webpacker:install
$ rails webpacker:install:react
$ yarn add @babel/preset-react
$ yarn add @rails/activestorage
$ yarn add @rails/ujs
$ rails generate react:install
$ rails generate react:component App
$ bundle add devise
$ rails generate devise:install
$ rails generate devise User
$ rails db:migrate
$ rails generate controller Home
config/environments/development.rb
This line added:
config.action_mailer.default_url_options = { host: 'localhost', port: 3000 }
config/initializers/devise.rb
# This line replaced:
config.sign_out_via = :delete
# With this line:
config.sign_out_via = :get
File added in app/views/home called index.html.erb app/views/home/index.html.erb
<%= react_component 'App', {
logged_in: user_signed_in?,
current_user: current_user,
new_user_route: new_user_registration_path,
sign_in_route: new_user_session_path,
sign_out_route: destroy_user_session_path
} %>
app/views/layouts/application.html.erb
# This line replaced:
<%= javascript_importmap_tags %>
# With this line:
<%= javascript_pack_tag 'application', 'data-turbolinks-track': 'reload' %>
config/routes.rb
# These lines added:
get '*path', to: 'home#index', constraints: ->(request){ request.format.html? }
root 'home#index'
yarn add [email protected]
app/javascript/components/App.js
import {
BrowserRouter as Router,
Route,
Switch
} from 'react-router-dom'
bundle add bootstrap
mv app/assets/stylesheets/application.css app/assets/stylesheets/application.scss
yarn add reactstrap
app/assets/stylesheets/application.scss
@import 'bootstrap';
Once you're able to clone the repository, within the root of the project directory, run:
bundle
yarn
rails db:setup
rails s
See what is available already in the application.
-
What can a USER do?
- Sign in/out
-
What views (pages, components) are available?
- See a home, Edit, Index, New, and Show page
The Devise User model is going to have an association with the Apartment model. In this situation, the User will have many apartments and the Apartments will belong to a User.
rails generate resource Apartment street:string city:string state:string manager:string email:string price:string bedrooms:integer bathrooms:integer pets:string image:text user_id:integer
rails db:migrate
The Apartments will belong to a User and a User will have many apartments.
app/models/apartment.rb
class Apartment < ApplicationRecord
belongs_to :user
end
app/models/user.rb
class User < ApplicationRecord
# Include default devise modules. Others available are:
# :confirmable, :lockable, :timeoutable, :trackable and :omniauthable
devise :database_authenticatable, :registerable,
:recoverable, :rememberable, :validatable
has_many :apartments
end
To run the existing testing suite, run:
yarn jest
rspec spec/
Part of your responsibility will be to build out robust tests both for models and for requests. Tests you will need are:
REQUEST:
- to ensure a user can see all apartments
- to ensure a user can see all apartments that belong to them
- to ensure a user can make a new apartment
- to ensure a user can update an apartment
- to ensure a user can remove an apartment
- to ensure a user cannot make a new apartment with nil values
- to ensure an error will be thrown if an unregistered user tried to make an apartment
- to ensure an error will be thrown if a user tries to edit an apartment that doesn't belong to them
- to ensure an error will be thrown if a user tries to delete an apartment that doesn't belong to them
MODELS:
- to ensure apartment is valid
- to ensure a user cannot make a new apartment with nil values
- to ensure a user cannot make a new apartment that already exists in the database
- to ensure a user cannot update an apartment with nil values
- to ensure a user cannot update another user's apartment
The following code is a mock and does not work but is here to get your started.
require 'rails_helper'
RSpec.describe "Apartments", type: :request do
describe "GET /index" do
it 'returns a list of apartments' do
user = User.where(email: '[email protected]').first_or_create(password: '12345678', password_confirmation: '12345678')
user.apartments.create(
street: string,
city: string,
state: string,
manager: string,
email: string,
price: string,
bedrooms: integer,
bathrooms: integer,
pets: string,
image: text
)
get '/apartments'
apartments = JSON.parse(response.body)
expect(response).to have_http_status(200)
expect(apartments.length).to eq(1)
end
end
end
app > javascript > components > components > header.js the navlink to your github might need to change to a href and not a to (L.75)