-
Install Docker and
docker-compose. Please follow the instructions on how to do so in the links below.a. Docker
-
Install Ruby and Ruby on Rails.
a. One of the easiest ways to do this: http://installrails.com
-
Install Node.js. Please follow instructions on how to do so in the links below.
a. Node.js
-
Install PostgreSQL. Please follow instructions on how to do so in the links below.
a. PostgreSQL
-
Make sure you the yarn package manager installed by running:
npm i -g yarna.
yarnis a great alternative tonpmas a dependency manager for Node.js. Read more here.
Disclaimer: Windows users, it is highly recommended that the entire setup process should be done through the Windows Subsystem for Linux (WSL). Setting up WSL can be found here.
Pre-req: As mentioned in configuration, you must recieve the .env file from GTHC project leaders before beginning setup process.
-
Install all packages/dependancies.
a. Run
bundle installb. Run
yarn install -
yarn run setupa. This yarn script should run all of the necessary shell scripts to setup your Docker containers, bundle (ruby gems) dependencies, and your node dependencies.
-
yarn dev:starta. This will start a local developer server, by default that will be on port 5000. (
http://localhost:5000)b. Always run this command from here on out to start the local server.
It is required that your system is running Rails 5.0+ for the local development to function properly. It is recommended to use the most recent version of Node, but anything above Node 8.x shall work.
Important: There are private environment variables needed for certain aspects of the application. Therefore, it will be required that you have a .env file in the root of your project before running anything. Please contact the project leaders (Aman or Anesu) for this information. Finally, the .env file should not be pushed to github under no circumstances!