Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/studio24/apollo
Front-end framework to help build websites with performance and accessibility as first-class passengers
https://github.com/studio24/apollo
css design-system html pattern-library
Last synced: 3 months ago
JSON representation
Front-end framework to help build websites with performance and accessibility as first-class passengers
- Host: GitHub
- URL: https://github.com/studio24/apollo
- Owner: studio24
- Created: 2019-10-25T14:01:40.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-01-03T12:38:59.000Z (about 1 year ago)
- Last Synced: 2024-07-30T18:04:36.258Z (6 months ago)
- Topics: css, design-system, html, pattern-library
- Language: SCSS
- Homepage: https://apollo.studio24.net/
- Size: 4.35 MB
- Stars: 11
- Watchers: 6
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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](https://github.com/studio24/apollo/tree/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](https://bitbucket.org/studio24/wordpress-installation-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
* Live - https://v1.apollo.studio24.net/
* Staging - http://apollo-staging.s24.net
* Development - http://local.apollo.s24.net
## How do I get set up?
### Clone the repository
```bash
git clone [email protected]:studio24/apollo.git
```
If you have Apollo already, to update the origin repo to GitHub:
```bash
git remote set-url origin [email protected]:studio24/apollo.git
```
### Installation
```bash
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
```bash
npm run build
```
To watch for changes
```bash
npm run watch
```
## Dependencies
- [NPM](https://www.npmjs.com/) - Package manager for Javascript
- [NVM](https://github.com/creationix/nvm) - Manage multiple active versions of node.js
## Deployment instructions
### Deploying to Staging
````bash
ssh [email protected] deploy studio24/apollo staging master nodb
````
### Deploying to Live
````bash
ssh [email protected] deploy studio24/apollo live master nodb
````
## Contribution guidelines
### To report an issue
Open a ticket in the [Issues section of this repository](https://bitbucket.org/studio24/apollo/issues?status=new&status=open). 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?
- Carlos Eriksson - [[email protected]](@[email protected]) - Slack @carlos