Roll for Guild: Character Generator

Setting up

The only prerequisites for running the application are currently git and Docker. Once you have those installed, follow the instructions below:

1. Grab the repo

git clone https://github.com/RollForGuild/rollforguild.com.git

2. Spin up the docker containers

docker-compose up

Some things you'll need

Environment Variables

Make a copy of the .env.example file and rename it to .env. In that file, change the environment variables as necessary. Here's a description of what each one is for:

Name	Required	Purpose
RFG_API_URL	false	This is the URL the application will proxy API requests to
RFG_APP_PORT	false	This is the port to run the application on
RFG_GOOGLE_MAPS_API_KEY	true	This is the API key for Google Maps
RFG_GOOGLE_TAG_MANAGER_ID	true	This is the ID for Google Tag Manager
RFG_LOCAL_API_URL	false	This is the URL the application will use for the local API proxy
RFG_REPOSITORY_URL	false	This is the URL that the build info in the header will lead to if not overridden by CircleCI variables
RFG_WORDPRESS_API_URL	false	This is the URL the application will use to retrieve Wordpress data from

Debugging

VS Code

For debugging in the browser:

1. Install the Debugger for Chrome extension for VS Code
2. Open the Debug tab and run the RFG: Client program

For debugging in the Docker container:

1. Spin up the Docker containers:

docker-compose up

1. Attach the VS Code debugger to the docker container using the Attach to Docker config

Code Style

ESLint

We have ESLint setup to error if our code styles aren't adhered to. Feel free to PR changes to the ESLint file, but make sure the do so as an individual PR. Changes to ESLint that are included with other changes will not be approved.

Commits

Commits to this project should use the Angular commit conventions. We'll be adding a listing of allowed scopes in the future.