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.
We are very happy with your interest in collaborating on the project, before starting read this guide carefully. Before submitting any pull request see the issues guide, if your demand is not there create a new one and wait for approval for development.
We use kanban as a workflow, take a look there and see what's going on.
- Ruby 3.0.0
- Rails 6.1.3
- Node 14.0.0
- Postgres 13.2.1
- You are familiar with Git.
- Be curious and enjoy solving problems.
Importantly, add an SSH key to your github account.
Make sure your git has user and email settings
git config --global user.name "FIRST_NAME LAST_NAME"
git config --global user.email "[email protected]"
Then clone the repository
git clone -o upstream [email protected]:vczb/gamou.git
Fork the repository
Enter the cloned directory
cd gamou
Add remote origin
git remote add origin [email protected]:<YOUR GITHUB USERNAME>/gamou.git
Install the dependences
yarn install
bundle install
Create a Postgres user
execute the commands in psql console
CREATE USER gamou WITH ENCRYPTED PASSWORD 'gamou';
ALTER USER gamou WITH SUPERUSER;
Create database and run the migrations
rails db:setup
rails db:migrate
Run the app
rails s
open another terminal
bin/webpack-dev-server
Open in your favorite browser
See all available commands
Follow this git workflow
If you are using VSCode we recommend this extensions
If you have any questions, please open an issue