Skip to content

Latest commit

 

History

History
147 lines (80 loc) · 3.21 KB

CONTRIBUTING.md

File metadata and controls

147 lines (80 loc) · 3.21 KB
Raw

How to Contribute to Gamou

Gamou is a fully open source project. See the LICENSE file for licensing information.

Before collaborating with the project, please read our code of conduct.

See our Wiki for more information about the project.

Getting Started

We are thrilled about your interest in contributing to Gamou. Please read this guide thoroughly before starting. Check the issues section before submitting any pull request. If your issue isn't listed, create a new one and wait for approval before proceeding.

We utilize a kanban workflow. Take a look to see what's currently in progress.

Required Versions

  • Ruby 3.0.0
  • Rails 7.0.8
  • Postgres 13.2.1
  • NodeJS 18.12.0

Contribution Prerequisites

  • Familiarity with Git.
  • A curious mind and a knack for problem-solving.

Preparing Your Setup

First, add an SSH key to your GitHub account.

Ensure your Git configuration is set up with your name and email:


git config --global user.name "FIRST_NAME LAST_NAME"
git config --global user.email "email@example.com"

Clone the repository:


git clone -o upstream git@github.com:vczb/gamou.git

Fork the repository and navigate into the cloned directory:


cd gamou

Add your fork as a remote origin:


git remote add origin git@github.com:<YOUR GITHUB USERNAME>/gamou.git

Install Ruby dependencies:


bundle install

Install JavaScript dependencies using Yarn:


yarn install

Create a Postgres user (execute in the psql console):


CREATE USER gamou WITH ENCRYPTED PASSWORD 'gamou';
ALTER USER gamou WITH SUPERUSER;

Set up the database:


rails db:setup
rails db:migrate

Configuring Local Domain

Before running the app, add custom domain mappings to your /etc/hosts file for local development:


echo '127.0.0.1 gamou' | sudo tee -a /etc/hosts
echo '127.0.0.1 app.gamou' | sudo tee -a /etc/hosts

Running the Application

To start the development environment for the React app along with the Rails backend, use:

./bin/dev

This will serve the React application and the Rails API. You can access the React app in your browser at http://app.gamou:3000.

Note: Running ./bin/dev starts both the Rails server and the esbuild process for the React app. If you wish to run only the API and the base Rails project without the React frontend, you can simply run:

rails s

and access the Rails-based projects and API at http://gamou:3000.

Development Workflow

Refer to the available commands and follow our git workflow.

For VSCode users, we recommend these extensions.

Thank You

If you have any questions, feel free to open an issue.