Beloved Projects

An application where users are able to browse different projects uploaded by others, and also give feedback by commenting or reviewing.

Built With

• Ruby on Rails - Core framework
• PostgreSQL - Used for development database

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

Make sure you have installed all of the following prerequisites on your development machine:

Linux or macOS

1. Get asdf-vm
2. Install required plugins

   asdf plugin add ruby
   asdf plugin add nodejs
   asdf plugin add yarn
   asdf plugin add postgres

3. Install tools

   asdf install

4. NOTE: You may get an error here saying role <username> does not exist. If this happens, try the following:

   psql -U postgres
   CREATE ROLE <username> SUPERUSER;
   ALTER ROLE "<username>" WITH LOGIN;

Windows

Please refer to .tool-versions for the exact versions of the required dependencies.

1. Install Ruby with RubyInstaller. (Note: you need a Ruby+Devkit installer)
2. Install NodeJs
3. Install yarn with npm install -g yarn

Installing

After installing the Prerequisites, you need to

1. Install all dependencies

   bundle install
   yarn install

2. Start your postgres server by running

   postgres

3. Create, migrate and seed the database

   rails db:setup

4. Start your local development server

   rails s

5. Install and run mailcatcher SMTP server

   gem install thin -v 1.5.1 -- --with-cflags="-Wno-error=implicit-function-declaration"
   gem install mailcatcher
   mailcatcher -bf

Development

On your local machine, you'll need to run the following services:

postgres
bin/shakapacker-dev-server
rails s

You can also run the SMTP server with:

mailcatcher -b

If you would like to run all required services within a single terminal window, you should install Overmind. The project contains a Procfile.dev which you will be able to run with:

overmind start

Testing

The test suite is setup with the following technologies:

• RSpec
• FactoryBot
• Faker

Current linters in the application are:

• Rubocop
• ERB Lint

You can run all quality assurance features like so:

rubocop
erblint .
rspec

Deployment

You can find Beloved Projects on the web. It is deployed to Heroku. Below you will find a set of instructions on how to setup the deployment process.

1. Install Heroku CLI.
2. Create an account for Heroku.
3. Inside the project directory:

   heroku login
   heroku apps:create beloved-projects
   heroku git:remote -a beloved-projects
   heroku buildpacks:add --index 1 heroku/nodejs
   heroku buildpacks:add --index 2 heroku/ruby
   git push heroku master
   

4. You will have to create a PostgreSQL database on Heroku manually.
5. Load your schema and migrate your database with the following commands:

   heroku run rake db:schema:load
   heroku run rake db:migrate
   

6. Done. You should check your deployed app's URL under Settings/Domains.