@afconsult/apollo

Apollo Design System

Design system for Enterprise Web Apps

Getting Started

Install

Install with npm:

npm install @afconsult/apollo --save

Install with Yarn:

yarn add @afconsult/apollo

Example

1. Import the stylesheet:

import '@afconsult/apollo/dist/css/apollo.css';

1. Import required apollo components:

import { Button, Form, FormGroup, Input, Label } from '@afconsult/apollo';

1. Use the components:

class Example extends React.PureComponent {
  render() {
    return (
      <Form>
        <FormGroup>
          <Label for="example">Example Input</Label>
          <Input id="example" placeholder="Inser text here..">
        </FormGroup>
        <Button type="submit">Submit</Button>
      </Form>
    );
  }
}

Components

• Avatar
• Badge
• Breadcrumbs
• Buttons
• Button Group
• Collapse
• Container
• Dropdowns
• Follow
• Forms
• Jumbotron
• Loader
• Mention
• Modals
• Navs
• Navbars
• Tag

Contribute

Feel free to create an issue or feature request.

Development

1. Install dependencies:

yarn install

1. Run examples at http://localhost:8080/ with webpack dev server:

yarn run start

Release

Note: you must have the GITHUB_TOKEN environment variable set to a valid GitHub token with write access to your repo.

1. Run release script and follow the instructions:

yarn run release

1. Run publish script to publish apollo to npm.

yarn run publish

Authors

Jon Wahlström (jonwa)

See also the list of contributors.

License

This project is licensed under the MIT License - see the LICENSE file for details.