Welcome to the Bark and Tweet Weather App! This application is built with Ruby on Rails and utilizes several important tools and services such as rspec (testing), rubocop (linting), PostgreSQL (database), and redis (caching). Below you will find all the necessary information to get started with this application.
- Getting Started
- Prerequisites
- Installation
- Configuration
- Running the Application
- Testing
- Code Linting
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
Before you begin, ensure you have the following installed:
- Ruby 3.3.0
- Rails
- PostgreSQL
- Redis
- Bundler
-
Clone the Repository
git clone https://github.com/jdalt/bark-and-tweet-weather.git cd bark-and-tweet-weather
-
Get a copy of Master Key
Get a copy of the master encryption key from another developer on the project.
-
Install Dependencies
bundle install
-
Set Up Database
Ensure PostgreSQL is running, then execute:
rails db:create rails db:migrate
-
Start Redis Server
Ensure Redis is running.
- Configure your database connection settings in
config/database.yml
. - Additional environment specific settings can be configured in
config/environments/
.
To run the application on your local server:
bundle exec rails s
The application will be available at http://localhost:3000
.
This application uses RSpec for testing. To run tests, execute:
bundle exec rspec
RuboCop is used for code linting and formatting. To run RuboCop:
bundle exec rubocop
To auto-correct offenses:
bundle exec rubocop -A