informaticacba / w3c-website-frontend

Frontend website for w3.org

W3C frontend website

Symfony frontend website for w3.org

Reporting issues

Please report any issues to the w3c-website repo.

Getting started

This document is a summary of what you need to know when working on this project. Please also read the more detailed project documentation

In this document

• Site URLs
• Deployment
• Installation
• Built with
• Credits

Site URLs (TBC)

Production

Live:

• https://www.w3.org
• https://www.w3.org/_build_summary.json (very brief summary of latest deployment)

Beta:

• https://beta.w3.org
• https://beta.w3.org/_build_summary.json

Staging

• https://www-staging.w3.org
• https://www-staging.w3.org/_build_summary.json

Development

• https://www-dev.w3.org
• https://www-dev.w3.org/_build_summary.json

Access to https://www-dev.w3.org is restricted by IP.

Local

• http://localhost:8000/ (see running application locally)

Deployment (TBC)

The project uses Deployer to perform deployment. For full deployment details/options view docs/deployment

Please note this project uses a local instance of Deployer (installed via Composer), as opposed to a global version of Deployer. This is so we can make use of other Composer packages in deployment tasks reliably (otherwise there can be clashes between global and local version of the same packages).

To run deployments please use:

vendor/bin/dep deploy <environment>

To deploy a specific branch use

vendor/bin/dep deploy <environment> --branch=<branch_name>

E.g.

vendor/bin/dep deploy development --branch=develop

SSH access

To connect to the server directly at the correct path for an environments current release, run the following from the root of the project

vendor/bin/dep ssh <environment>

Installation

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

You will need to obtain from another developer: [to update later as sharing process put in place]

• A copy of a local .env.local file

Clone the repository

git clone [email protected]:w3c/website-frontend.git

Run composer install

Create a local environment file and populate the required variables (see .env.local.dist).

cp .env.local.dist .env.local

More on the Git workflow for this project.

Running application locally

You can run the frontend application locally at http://localhost:8000/ by running the command:

symfony server:start

Built with

• Symfony
• Strata Frontend
• W3C Design System (used as a Symfony template bundle)