Skip to content
Snippets Groups Projects
readme.md 3.43 KiB
Newer Older
khawkins98's avatar
khawkins98 committed
[![Build Status](https://travis-ci.org/ebiwd/EBI-Style-lab.svg?branch=master)](https://travis-ci.org/ebiwd/EBI-Style-lab)
[![Gitter](https://img.shields.io/gitter/room/nwjs/nw.js.svg)](https://gitter.im/ebiwd/EBI-Framework)

Ken Hawkins's avatar
Ken Hawkins committed
# 🚨 The Style Lab is reach end of life 🚨

The EMBL-EBI Style Lab complements the 1.x series of the Visual Framework, it is being superseded by version 2.

- [Information on the Visual Framework version 2](https://stable.visual-framework.dev/)
Ken Hawkins's avatar
Ken Hawkins committed
- [About the retirement of 1.x](https://www.ebi.ac.uk/style-lab/websites/framework-next/)
Ken Hawkins's avatar
Ken Hawkins committed

# EMBL-EBI Style Lab
Ken Hawkins's avatar
Ken Hawkins committed

khawkins98's avatar
khawkins98 committed
This is a collaborative effort. The EMBL-EBI Style Lab is a place to communicate how we use visual identity, code and language to make better and more accessible services -- it exists because of pan-EMBL-EBI collaboration.
khawkins98's avatar
khawkins98 committed

khawkins98's avatar
khawkins98 committed
There's not much to see on this page, [check out the site at www.ebi.ac.uk/style-lab/](https://www.ebi.ac.uk/style-lab/)

## What is this, exactly?
Ken Hawkins's avatar
Ken Hawkins committed

The EMBL-EBI Style Lab is a collaborative space that also shares the latest guidance on how and what should be used to build visually and textually compliant EMBL-EBI websites, documents, and texts. It's partly about reinforcing our shared identity, but it's mostly about leveraging the best tools to build things faster and with fewer bugs, errors, and user experience issues.
### Contents of the EMBL-EBI Style Lab
Ken Hawkins's avatar
Ken Hawkins committed

Ken Hawkins's avatar
Ken Hawkins committed
- [General styling](httpss://www.ebi.ac.uk/style-lab/)
khawkins98's avatar
khawkins98 committed
  - [Our basic style guide](https://www.ebi.ac.uk/style-lab/general/)
  - [Microsoft Word and PowerPoint templates](https://www.ebi.ac.uk/style-lab/general/templates/)
  - [Poster templates](https://www.ebi.ac.uk/style-lab/general/templates/)
khawkins98's avatar
khawkins98 committed
  - [Logos](https://www.ebi.ac.uk/style-lab/general/templates/)
khawkins98's avatar
khawkins98 committed
  - [Fonts & icons](https://www.ebi.ac.uk/style-lab/general/fonts/)
  - [Social media guidelines](https://www.ebi.ac.uk/style-lab/general/social/)
- [Website specific](https://www.ebi.ac.uk/style-lab/websites/)
  - [How to get started with the EBI Visual Framework](https://www.ebi.ac.uk/style-lab/websites/#implementing)
  - [How to use the EBI Icon fonts on a website](https://www.ebi.ac.uk/style-lab/general/fonts/)
  - [Boilerplate templates to get started](https://www.ebi.ac.uk/style-lab/websites/sample-site/)
  - [Reusable web interface patterns](https://www.ebi.ac.uk/style-lab/websites/patterns/)
    - [How to add a pattern](https://www.ebi.ac.uk/style-lab/websites/patterns/howto/)
khawkins98's avatar
khawkins98 committed
---
Ken Hawkins's avatar
Ken Hawkins committed
## Are you a web developer?
khawkins98's avatar
khawkins98 committed

### How do I develop on my local machine

Ken Hawkins's avatar
Ken Hawkins committed
1. Your computer needs:
  - [NodeJS](https://nodejs.org/en/)
  - [Git](https://git-scm.com/)
2. Get the git repo: `git clone https://github.com/ebiwd/ebi-style-lab.git`
  - If you've not yet installed bower (you may need to run with sudo): `npm install -g bower`
3. Then open the folder in your command line, and install the needed dependencies:
    ```bash
    cd EBI-Style-lab
Ken Hawkins's avatar
Ken Hawkins committed
    npm install
    bower install
Ken Hawkins's avatar
Ken Hawkins committed
    ```
4. Finally:
Ken Hawkins's avatar
Ken Hawkins committed
  - To develop: 
Ken Hawkins's avatar
Ken Hawkins committed
    - `npm start` or `gulp bb` start the project and watch for changes in your browser at http://localhost:8000
Ken Hawkins's avatar
Ken Hawkins committed
  - To build for deployment: run `npm run build`
khawkins98's avatar
khawkins98 committed

#### Special things

- Pulling in the latest EBI Icon font samples:
     - `gulp updateIconFonts`

Ken Hawkins's avatar
Ken Hawkins committed
## Versioning

Ken Hawkins's avatar
Ken Hawkins committed
Releases are versioned according to the EBI Visual Framework being used. That is: while we uses the EBI Visual Framework v1.4, all EBI Style Lab releases will be v1.4.X
Ken Hawkins's avatar
Ken Hawkins committed

## Credit
Ken Hawkins's avatar
Ken Hawkins committed

khawkins98's avatar
khawkins98 committed
The base CMS configuration and code examples are forked from ZURB Foundation Building Blocks.