Africa Ruby Community(ARC) Platform

Introduction

On project is aimed a building a platform that African ruby language enthusiasts can use to connect, share their knowledge and experience, collaborate on projects, and stay up-to-date with the latest developments in the Ruby community. Whether you're a seasoned developer or a beginner just starting out. The platform features a variety of resources including different chapters for different countries and cities, merchandise, meetup information etc. It will also help users get information on online workshops, webinars, and meetups organized by the community, to learn from experts and network with other enthusiasts.

Project Design: https://still-snowflake-8822.animaapp.io/

Nb: Please note that this project is open source, you are therefore encourage to contribute

Application Setup

Step 1: Install prerequisites

Installing Ruby Version Manager(RVM) package

RVM is a command-line tool which allows you to easily install, manage, and work with multiple ruby environments from interpreters to sets of gems. It supports both UNIX like systems and Windows (with Cygwin or Bash on Ubuntu on Windows.

Run the following in the terminal or CMD (on Windows)

$ \curl -sSL https://get.rvm.io | bash -s stable

Restart the terminal or cmd and run command below to check if rvm is installed.

$ rvm list

Installing ruby via RVM

$ rvm install <ruby version>

e.g. Ruby Version 3.0.2

Installing Rails via RVM

Since Rails is a gem, which is a standardized format that contains Ruby programs, you can also install various versions of Rails by using the gem command

$ gem install rails -v <rails specified version>

e.g. Rails Version 7.0.3

NB: For more installation details, checkout Installing RVM documentation on the same.

Installing rbenv

rbenv is a version control tool for Ruby. It helps you switch between different Ruby versions and make sure that every project you are working on always operates independently on the designated version.

Usage

You can choose the Ruby version for your project with, for example:

cd myproject
# choose Ruby version 3.1.2:
rbenv local 3.1.2

Installation

On systems with Homebrew package manager, the “Using Package Managers” method is recommended. On other systems, “Git Checkout” might be the easiest way of ensuring that you are always installing the latest version of rbenv.

Using Package Managers

Install rbenv using one of the following approaches.

Homebrew

On macOS or Linux, we recommend installing rbenv with Homebrew.
```
$ brew install rbenv ruby-build
```
Debian, Ubuntu, and their derivatives

Note that the version of rbenv that is packaged and maintained in the Debian and Ubuntu repositories is out of date. To install the latest version, it is recommended to install rbenv using git.
```
$ sudo apt install rbenv
```
Arch Linux and its derivatives

Archlinux has an AUR Package for rbenv and you can install it from the AUR using the instructions from this wiki page.

Load rbenv in your shell.

# run this and follow the printed instructions:
$ rbenv init

Restart your terminal so your changes take effect.

That's it! You are now ready to install different ruby versions.

Basic Git

Clone rbenv into ~/.rbenv.

$ git clone https://github.com/rbenv/rbenv.git ~/.rbenv

Configure your shell to load rbenv:

For bash:

Ubuntu Desktop users should configure ~/.bashrc:

$ echo 'eval "$(~/.rbenv/bin/rbenv init - bash)"' >> ~/.bashrc

On other platforms, bash is usually configured via ~/.bash_profile:

$ echo 'eval "$(~/.rbenv/bin/rbenv init - bash)"' >> ~/.bash_profile

For Zsh:

echo 'eval "$(~/.rbenv/bin/rbenv init - zsh)"' >> ~/.zshrc

Restart your shell so that these changes take effect.

Installing ruby via rbenv

Before attempting to install Ruby, check that your build environment has the necessary tools and libraries. Then:

# list latest stable versions:
rbenv install -l
# list all local versions:
rbenv install -L
# install a Ruby version:
rbenv install 3.1.2

All done!

You are now free to proceed to the steps below:

Step 2: Create a Fork & Branch

Create a fork of this repository from main branch
Select an issue to work on from the main repository
Create a branch name to match the selected issue from the main branch

NB:

Always make sure your fork is in sync with the main
All changes you changes for the issue will be on this branch

Step 3: Clone & install dependencies

Run the following command in the terminal

$ git clone <link to you forked repo>

$ cd <path to your cloned repo>

$ bundle install

Step 4: Setup the database

$ rails db:create

$ rails db:migrate

Step 4: Install yarn dependancies

yarn install

Step 5: Start server

$ rails server

$ rails s

step 5: Creating a pull request

make changes locally on your branch
push your changes to your branch on github
create a pull request to main branch of the main repository

step 5: Merging

Once your changes are reviewed they will be merged to the main branch

NB: The section below outlines how the README should be written

README

This README would normally document whatever steps are necessary to get the application up and running. (guide)

Things you may want to cover:

Ruby version
System dependencies
Configuration
Database creation
Database initialization
How to run the test suite
Services (job queues, cache servers, search engines, etc.)
Deployment instructions
...

Kihara-Kamotho/arc_platform