How to run locally

• Installing Ruby & Rails
• Cloning this Repository
• Installing & Configuring Postgres
• Installing Dependencies
• Running Migrations & Seeds
• Starting the Application

How to run the tests

Running The Project Locally

Installing Ruby & Rails

Installing Ruby

First of all in order to install ruby. Head to the official Ruby website and refer to the "Ways of Installing Ruby" section.

After making sure that Ruby is installed You can test to see if it's working by typing ruby -v in the command line.

You also need to install the bundler gem which will be used later to manage & install dependencies. You can install it by running gem install bundler.

Installing Rails

Now to install Rails all you have to do is run gem install rails and you're good to go to the next step.

Cloning This Repository

• To clone using SSH run git clone git@github.com:Bismarck-GM/liFEsMemes-Rails.git
• To clone using HTTP run git clone https://github.com/Bismarck-GM/liFEsMemes-Rails.git

Note: In case you don't have Git Installed. You can download this repo using this link

Installing & configuring postgres

Installing postgres

Different guides based on operating systems.

• Ubuntu
• Arch Linux
• Debian
• Windows

Creating a new postgres user

Create a new postgres superuser with the same name as your username by using the createuser --interactive command and when prompted whether you want the user to be a super user enter y.

You can get your current username by running whoami on linux based systems.

Sometimes you may get an error "Fatal: role "your username” does not exist", which means that your user isn't allowed to create other users and in that case you may need to switch to the postgres user before running the command again. Refer to this stackoverflow answer for more details.

Creating the project's database

Lastly. You need to create a database with the name lifestyle. You can do that by running the following command createdb lifestyle -O <your username>. The -O flag sets the owner of the database (Don't forget to replace <your username> with your actual username)

Configuring postgres

Changing postgres to development mode (this makes it easier to connect to the database and create and drop databases in order to run the tests)

Look for a postgres config file called pg_hba.conf. The location of the file is different on each operating system. So you may have to do some googling.

Add the following lines to the pg_hba.conf file

# IPv4 local connections:
host    all             all             127.0.0.1/32            trust
# IPv6 local connections:
host    all             all             ::1/128                 trust

These lines instruct postgres to not require a password from connections made from localhost.

To find more details about this config file visit this link

Installing Dependencies

You can install the project's dependencies by running bundle install in the root directory of the porject. Note: Running this command might take some time. So feel free to go make some coffee or do any activity.

Running Migrations and Seeds

You can migrate the database by running rails db:migrate. For this project to work it's necesary to run the seeds: rails db:seed. Note: Make sure to run both commands in the root directory of the project.

Starting The Application

And finally after all the hard work. You can start the application by running rails s. You can access the app by typing http://127.0.0.1:3000 in the browser.

Running Rspec Tests

First of all you need to create the test database. You can do that by running the following command.

createdb lifestyle_test -O <your username>

If that doesn't work, refer to the Installing & configuring postgres and Creating the project's database.

Lastly. Running the tests is as simple as running bundle exec rspec spec in the root directory of this project.

Thanks Hasan (@wintercore) for this HOW TO !