https://github.com/classeur/classeur

Classeur frontend
https://github.com/classeur/classeur

Last synced: 5 days ago
JSON representation

Classeur frontend

• Host: GitHub
• URL: https://github.com/classeur/classeur
• Owner: classeur
• License: apache-2.0
• Created: 2015-09-29T18:28:38.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2018-02-11T19:43:46.000Z (over 6 years ago)
• Last Synced: 2024-10-01T22:09:43.807Z (about 1 month ago)
• Language: JavaScript
• Homepage: http://classeur.io
• Size: 1.74 MB
• Stars: 550
• Watchers: 28
• Forks: 57
• Open Issues: 112
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - classeur/classeur - Classeur frontend (others)

README

        
# Classeur frontend

[![Build Status](https://img.shields.io/travis/classeur/classeur.svg?style=flat)](https://travis-ci.org/classeur/classeur) [![NPM version](https://img.shields.io/npm/v/classeur.svg?style=flat)](https://www.npmjs.org/package/classeur)

[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)

> Frontend application as used in [Classeur](https://app.classeur.io).

This app was made possible thanks to these great libraries:

- [AngularJS](https://github.com/angular/angular.js)

- [Markdown It](https://github.com/markdown-it/markdown-it)

- [Prism](https://github.com/PrismJS/prism)

The [cledit library](https://github.com/classeur/cledit) is also an important part of the project.

## Get started

### Install

```sh

npm install

```

### Start

```sh

npm start

```

Classeur works with a back-end in order to provide connected features such as synchronization, sharing and collaboration. Please refer to the [enterprise documentation](https://classeur.zendesk.com/hc/en-us/articles/208399869-On-prem-installation) for a full installation of Classeur.

## Contributing

We gladly accept new features if they are useful for others and don't degrade the user experience.

### Code format

Code format is checked via the command `npm run lint-all` ensuring JS, HTML and SCSS files are formatted according to the following rules:

- JavaScript: [standard style](http://standardjs.com/)

- SCSS linted with [stylelint](http://stylelint.io/)

- SCSS formatted with [CSScomb](http://csscomb.com/)

- HTML linted with [HTMLHint](http://htmlhint.com/)

- HTML formatted with [JS Beautifier](http://jsbeautifier.org/)

### Style Guide

#### Naming convention

Classeur uses [hyphenated BEM](http://csswizardry.com/2013/01/mindbemding-getting-your-head-round-bem-syntax/) as a naming convention for CSS classes.

## License

[Apache](https://github.com/classeur/classeur/blob/master/LICENSE)