Getting Started

https://github.com/Squarehub/squarehubgithub.com

Versions are referenced in the Gemfile and in the package.json file, you might want to double check them!

MacOs installation

Prerequisites:

• Install ruby 3.2.0 via rvm (rvm install 3.2.0 && rvm use 3.2.0)

• Rails 7.0.8.4

• Install foreman via gem install foreman

• Install postgresql v14 (OSX: brew install postgresql@14)

• Install elasticsearch v7.10.2 (OSX: brew tap elastic/tap && brew install elastic/tap/elasticsearch-full)

• start elasticsearch service (OSX: brew services start elasticsearch-full)

• install the required gems (OSX: bundle install)

• Install JS packages with yarn in the project folder (OSX: yarn install)

• Setup databases with rails (OSX: rails db:setup)

Windows installation

• Install Virtual Box

• Install Oracle_VM_VirtualBox_Extension_Pack

• Download and run Ubuntu (20.04) on the virtual machine

• Install RVM with this guide https://github.com/rvm/ubuntu_rvm

• Install ruby 3.2.0 via rvm

• Install Rails 7.0.8.4

• Install foreman via gem install foreman

• install postgresql https://www.digitalocean.com/community/tutorials/how-to-install-postgresql-on-ubuntu-20-04-quickstart-fr

• install and start elasticsearch https://linuxize.com/post/how-to-install-elasticsearch-on-ubuntu-20-04/

• Run yarn in the project folder

Launch app in DEV env:

• foreman start -f Procfile.dev-hmr

Known issues

• .env (you needed to have .env setup)

• master.key / development.key ( check heroku global var, for add the good key)

• issue with Ventura and elasticsearch (no resolution actually, need to downgrade)

Now that you are ready to code, let's have a look at our stack!

Our stack