Skip to content

Latest commit

 

History

History
105 lines (65 loc) · 2.96 KB

README.md

File metadata and controls

105 lines (65 loc) · 2.96 KB
Raw

Apollo

This is a static (HTML, CSS and Javascript) framework with performance and accessibility as first-class passenger.

Please note the new version of Apollo is being actively developed in the apollo-v2 branch and is planned for completion in early 2020.

What is this repository for?

Apollo is used in the Studio24 Wordpress starter theme with the same name. It's part of the Wordpress installer script. The following file(s) and folder(s) should be deleted after installation. They are used for this repository itself and are not needed when used in the theme.

  • /delete-this-folder-in-wp
  • apollo.php

Preview URLs

How do I get set up?

Clone the repository

git clone git@github.com:studio24/apollo.git

If you have Apollo already, to update the origin repo to GitHub:

git remote set-url origin git@github.com:studio24/apollo.git

Installation

cd apollo/web

# Switch your version of Node using NVM
nvm use v10.2.1

# Install dependencies
npm install
npm run build

Configuration

NPM config file

If needed, update package.json to manage the packages and NPM scripts required to build the site's assets.

Build

To re-build the assets once

npm run build

To watch for changes

npm run watch

Dependencies

  • NPM - Package manager for Javascript
  • NVM - Manage multiple active versions of node.js

Deployment instructions

Deploying to Staging

ssh studio24@goldeneye.studio24.net deploy studio24/apollo staging master nodb

Deploying to Live

ssh studio24@goldeneye.studio24.net deploy studio24/apollo live master nodb

Contribution guidelines

To report an issue

Open a ticket in the Issues section of this repository. Assign it to the repository maintainer (Carlos) for discussion.

To submit a bug fix or an enhancement

I'm so excited that you want to contribute to Apollo. Before you do though, please take a moment to consider how you would answer the following questions. A single 'Yes,' already tells us we would want your addition.

  1. Does this solution already exist? (drop-down, select menu, tooltip, video player, etc.)
  2. Could others use it? (Yes, no, maybe)
  3. Have you already seen a working solution for this? (It works well, it needs improvement)
  4. Does it solve the problem? (Yes, no, partially)

Create a new branch (one per fix/improvement) and apply your fix. When you are done, submit a pull request to the repository maintainer (Carlos) for review.

Who do I talk to?