Ghost/core/client
2014-10-21 14:01:40 +02:00
..
adapters Fix revoke user invite and user.destroy 2014-08-06 16:48:18 +00:00
assets Tag input UX improvements 2014-10-20 22:08:26 +01:00
components Cancel pending auto-save if manual save occurs 2014-10-20 18:40:45 +00:00
controllers Ensure slug generation has completed prior to save 2014-10-20 19:15:01 +00:00
docs Adding Grunt tasks for Sass 2014-08-31 14:16:58 +01:00
helpers Rename helpers/ghostPaths.js -> helpers/ghost-paths.js 2014-09-24 20:06:42 -05:00
html Tag Management UI Markup 2014-09-30 22:43:59 +01:00
initializers Rename popovers to dropdowns 2014-09-30 10:48:21 +01:00
mixins Ensure slug generation has completed prior to save 2014-10-20 19:15:01 +00:00
models Prevent editor title from being overwritten 2014-09-04 19:27:59 +00:00
routes Show all invited users and infinite scroll active 2014-10-16 20:09:03 +00:00
serializers Don't send HTML on post save. 2014-09-04 18:32:34 +02:00
templates Tag input UX improvements 2014-10-20 22:08:26 +01:00
transforms Changed ember models to use moment for dates 2014-06-05 10:30:28 -06:00
utils Clean up hardcoded ghost paths 2014-10-06 16:33:58 +02:00
validators Reset password signs the user in 2014-10-03 15:22:20 -06:00
views Tag input UX improvements 2014-10-20 22:08:26 +01:00
_config.yml Adding Grunt tasks for Sass 2014-08-31 14:16:58 +01:00
.jshintrc updated Ember Simple Auth to latest version 2014-07-25 16:04:19 +02:00
app.js Rename helpers/ghostPaths.js -> helpers/ghost-paths.js 2014-09-24 20:06:42 -05:00
config-dev.js Get Ember Admin ready for production 2014-07-22 22:33:49 +00:00
config-prod.js Get Ember Admin ready for production 2014-07-22 22:33:49 +00:00
loader.js Add jscs task to grunt file and clean up files to adhere to jscs rules. 2014-09-17 21:44:29 -04:00
README.md First pass refactor of GUI readme redux 2014-08-31 16:56:41 +03:00
router.js Implement About Ghost page 2014-09-02 13:49:01 -06:00

Ghost-UI

[Travis] [SauceLabs]

Ghost-UI is the Ember.js application used as a client-side admin for the Ghost blogging platform. This readme is a work in progress guide aimed at explaining the specific nuances of the Ghost Ember app to contributors whose main focus is on this side of things.

Architecture

ToDo: Explain the basic Ember app structure.

client/
├── assets/
│   ├── ghost.css
│   └── ghost.min.css
├── things/
│   ├── things.js
│   └── things.min.js
└── things/
    ├── things.js
    └── things.js

SASS

All CSS is written in SASS and compiled using grunt. We do not follow any strict CSS framework, however our general style is pretty similar to BEM.

Styles are primarily broken up into 4 main categories:

  • Helpers - are pure-sass files. Variables/mixins/things which are generally never compiled to actual CSS, and are simply used to aid development.
  • Patterns - are base level visual styles for HTML elements (eg. Buttons)
  • Components - are groups of patterns used to create a UI component (eg. Modals)
  • Layouts - are groups of components used to create application screens (eg. Settings)
  • Lib - is where we store styles for 3rd party components.

All of these separate files are subsequently imported and compiled in screen.scss.

Front End Standards

  • 4 spaces for HTML & CSS indentation. Never tabs.
  • Double quotes only, never single quotes.
  • Use tags and elements appropriate for an HTML5 doctype (including self-closing tags)
  • Adhere to the Recess CSS property order.
  • Always a space after a property's colon (.e.g, display: block; and not display:block;).
  • End all lines with a semi-colon.
  • For multiple, comma-separated selectors, place each selector on its own line.
  • Use js- prefixed classes for JavaScript hooks into the DOM, and never use these in CSS as per Slightly Obtrusive JavaSript
  • Avoid SASS over-nesting. Never nest more than 3 levels deep.
  • Use comments to explain "why" not "what" (Eg. This requires a z-index in order to appear above mobile navigation. Not: This is a thing which is always on top!)