Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/h3ar7b3a7/friendslist
Revisiting Ruby on Rails nearly 10 years later by making a friend list application with some help of freeCodeCamp.org.
https://github.com/h3ar7b3a7/friendslist
bootstrap4 crud heroku rails6
Last synced: 8 days ago
JSON representation
Revisiting Ruby on Rails nearly 10 years later by making a friend list application with some help of freeCodeCamp.org.
- Host: GitHub
- URL: https://github.com/h3ar7b3a7/friendslist
- Owner: H3AR7B3A7
- Created: 2020-11-27T00:20:13.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2020-12-02T03:00:01.000Z (almost 4 years ago)
- Last Synced: 2024-11-02T16:25:52.523Z (12 days ago)
- Topics: bootstrap4, crud, heroku, rails6
- Language: Ruby
- Homepage:
- Size: 248 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://efriends.herokuapp.com)
# Ruby On Rails: Friends List
Revisitting Ruby on Rails after a long time by making a ['Friends List'](https://efriends.herokuapp.com/) application with some help of freeCodeCamp.org.
[Official Guides](https://guides.rubyonrails.org/)
We can make use from the CLI to generate a project or modules to make our life easyer. (Similar to what we can do in other frameworks like React, Angular, ...)
To create a new project:
rails new
To start the server:
rails s
## Application.html.erb
Here we keep the structure of our app seperate from the changing content represented by: **<%= yield %>**.
Everything that doesn't change from page to page in our application can be in here:
- metadata
- styling
- partials
- ...
## Partial
We can create other html blocks, or *partials*, by creating a new file under views using the pattern:
*_.html.erb*
We can insert this block like this:
<%= render '/' %>
Notice the leading underscore is left out of the block we insert.
## New pages
As usual a new page needs:
- **View**: viewName.html.erb in views folder
- **Controller**: controllerName_controller.rb in controllers folder
- **Routing**: routes.rb in config folder
We can do this manually, but this CLI command will do this for us:
rails controller home index
## Application helper
Instead of using javascript to check which page is active we can move this logic to rails using **is_active** in *application_helper.rb*
def is_active(action)
params[:action] == action ? "active" : nil
end
In the list items in our header this logic can be applied like this:
<%= link_to 'Home', root_path, class:"nav-link" %>
## Scaffold
We use the following CLI command to create a scaffold in *'db/migrate'*:
rails g scaffold friends first_name:string last_name:string email:string phone:string twitter:string
To create the schema from this scaffold we use this command:
rails db:migrate
This will not only create a database, but also fully functional CRUD pages to create , update or view entries in *'views/friends'*. This includes even an .scss we deleted in this case because we want to add our own stylign with bootstrap.
## Flash messages
Whenever something goes wrong with CRUD transactions rails will generate messages. To display these messages it needs some placeholders:
<%= notice %>
<%= alert %>
We can put these anywhere we might need them, so creating a partial we can render anywhere is a good practice.
## Devise
To add the gem go to [Ruby Gems](https://rubygems.org/) and look for devise. You can easily copy the gemfile code with 'copy to clipboard' and pasting it in the project Gemfile.
In the console we use the following command to have the gem installed:
bundle install
We can find the devise [README](https://github.com/heartcombo/devise) for more information on how to use it.
We will find that we also need to enter the following command in the console:
rails generate devise:install
Notice that the console will output more instructions:
- To configure an Action Mailer, to send people a password when they lost it and similar funtionality.
In *'config/evironments/development.rb'* and *'config/evironments/production.rb'*:
config.action_mailer.default_url_options = { host: 'localhost', port: 3000 }
- Make sure we have a root page
- Make sure we have flash messages like 'notice' and 'alert'.
- Create devise views.
To create Devise views enter the following in the console:
rails g devise:views
Devise will also need a *'scaffold'* (or database model) for users, which we can generate with:
rails generate devise user
To create the schema from this scaffold we use the same command as before:
rails db:migrate
We can use the following handle to only display certain html code when the user is logged in by using *'if'* statements:
user_signed_in?
## Associations
[Official Guide: Associations](https://guides.rubyonrails.org/association_basics.html)
In the *models* folder we make these associations:
- **friend.rb**: belongs_to :user
- **user.rb**: has_many :friends
We also want to add a user id to our friends table so our schema keeps track of who the 'friends' belong to. For this we enter the following in our console:
rails g migration add_user_id_to_friends user_id:integer:index
And after a migration we use the same command as before again:
rails db:migrate
We also need to add *:user_id* to the list of trusted parameters in *friends_controller.rb* and add a hidden field to *_form.html.erb*:
<%= form.number_field :user_id, id: :friend_user_id,
class:"form-control", value:current_user.id, type: :hidden %>
We can prevent usage of the api by adding the following line to the top of *friends_controller.rb*:
before_action :authenticate_user!
Likewise we want to prevent users from editing friend records of other users:
before_action :correct_user, only: [:edit, :update, :destroy]
We define *'correct user'* like this:
def correct_user
@friend = current_user.friends.find_by(id: params[:id])
redirect_to friends_path, notice: "Not authorized to edit this entry" if @friend.nil?
end
We want to update the *new* and *create* methods too:
def new
@friend = current_user.friends.build
end
def create
@friend = current_user.friends.build(friend_params)
respond_to do |format|
if @friend.save
format.html { redirect_to @friend, notice: 'Friend was successfully created.' }
format.json { render :show, status: :created, location: @friend }
else
format.html { render :new }
format.json { render json: @friend.errors, status: :unprocessable_entity }
end
end
end
And finally we need to update the querry to only show friends with the right user id if we don't want other people to see the friends from other users.
def index
@friends = Friend.where(:user_id => current_user.id)
end
## Custom dialog
For a custom dialog add the following to *'application.js'*:
import Rails from "@rails/ujs";
Rails.confirm = function(message, element) {
let $element = $(element)
let $dialog = $('#confirmation-modal')
let $content = $dialog.find('#modal-content')
let $ok = $dialog.find('#ok-button')
$content.text(message)
$ok.click(function(event) {
event.preventDefault()
$dialog.modal("hide")
let old = Rails.confirm
Rails.confirm = function() { return true }
$element.get(0).click()
Rails.confirm = old
})
$dialog.modal("show")
return false;
}
And some dialog to your *'application.html.erb'*:
## Favicon
To add a favicon we add the file to the *'assets/images'* folder and simply add the following line to the head in *'application.html.erb'*:
<%= favicon_link_tag asset_path('image-name.png') %>
## Custom error pages
We can simply find the error pages in the *'public'* folder and edit them to our liking.
## Hosting an application on Heroku
- Make sure we are using a solid database like PostgreSQL for the production environment instead of sqlite3.
- Install Heroku toolbelt
- Login to Heroku:
heroku login
- Create an application on Heroku:
heroku create
heroku rename name
- Add SSL protection to the project:
heroku keys:add
- Push the application to heroku:
git push heroku master
- Migrate the database:
heroku run rails db:migrate
Et voilà ...