New FAForever main website
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
configuration
grunt
members
public
routes
scripts
templates
.dockerignore
.editorconfig
.env.example
.gitattributes
.gitignore
.jshintrc
.travis.yml
Dockerfile
Gruntfile.js
Procfile
README.md
express.js
package.json
yarn.lock

README.md

website

New Forged Alliance Forever main website to replace http://faforever.com

Requires Node and NPM. To install it, follow these steps :

git clone https://github.com/FAForever/website.git
cd website
sudo npm install -g yarn
yarn install
node_modules/.bin/grunt prod
yarn --prod
cp .env.example .env

Now you're ready to start the server. You can fire it using : PORT=3000 yarn start

In order to install grunt for the command line, please follow this guide - http://gruntjs.com/getting-started

Docker Install Guide

You will need to setup a default machine in a new terminal window. This can be accomplished by doing the following.

  1. Build docker image
→ docker build -t faf-website .
  1. Run docker image
→ docker run --name faf-website -p 3000:3000 -d faf-website
  1. Open the app in your browser
→ open http://$(docker-machine ip default):3000/

You can find your IP by doing

→ docker-machine ip

Adding stylesheets and javascripts

Since we are using grunt to handle all tasks, files must be registered in the correct grunt configurations. You can register a new stylesheet by going to grunt/sass.js. You will need to add the sass file underneath each category. The purpose behind each one is for dev and prod. In prod, it will minify the CSS, whereas DEV does not.

The same goes for Javascript. Any javascript needed will need to be registered under grunt/concat.js. This script puts all Javascript in one file, and will minify it in PROD.