TimeOverflow Installation Manual

Table of Contents

1. Introduction
2. Prerequisites
3. Local Installation
   • Environment Setup
   • Database Configuration
   • Application Initialization
4. Common Troubleshooting
5. References

Introduction

Timeoverflow is a time bank system designed to facilitate the exchange of services between community members. This manual provides instructions to set up a local development environment and start contributing to the project.

Prerequisites

Before starting the installation, make sure you have the following components installed:

• Ruby: Version 3.2.2
• Rails: Version 7.2
• PostgreSQL: Version 14 or higher
• Node.js: Version 16 or higher (for asset compilation)
• Git: To clone the repository

Local Installation

Environment Setup

1. Clone the Timeoverflow repository:

   git clone https://github.com/coopdevs/timeoverflow.git
   cd timeoverflow

2. Install Ruby 3.2.2 if you don't have it:

   rbenv install 3.2.2

   Note: When entering the project directory, rbenv will automatically switch to Ruby 3.2.2 thanks to the .ruby-version file.

3. Install the required Ruby gems (including Rails 7.2):

   bundle install

Database Configuration

1. Copy the environment variables configuration file:

   cp .env.example .env

2. Edit the .env file with your local PostgreSQL database configuration if necessary.
3. Run the automatic setup script:

   bin/setup

   This script will install dependencies, create databases, run migrations, and load initial data.

Application Initialization

1. Start the development server:

   bin/rails server

2. In a separate terminal, start Sidekiq to process background tasks:

   bundle exec sidekiq

3. Access the application through your web browser:

   http://localhost:3000

4. Use the default credentials to log in:
   • Email: admin@timeoverflow.org
   • Password: 1234test

Common Troubleshooting

Database connection error

• Verify that PostgreSQL is running
• Check the configuration in the .env file

Error "Ruby version not installed"

• Use rbenv to install Ruby 3.2.2:

  rbenv install 3.2.2

JavaScript runtime error

• Make sure you have Node.js 16+ installed

If bin/setup fails

• Manual alternative:

  psql -U your_user -d timeoverflow_development -f db/structure.sql
  bundle exec rails db:seed

References

• Official repository: https://github.com/coopdevs/timeoverflow
• Ruby on Rails documentation: https://guides.rubyonrails.org/
• PostgreSQL documentation: https://www.postgresql.org/docs/