diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 89642c2b..fa3c5865 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -31,3 +31,39 @@ If you're feeling adventurous, you can become a Git & GitHub master with the [Gi ## .editorconfig You should also make use of the [.editorconfig](/.editorconfig) file found within the root of the repository. It'll make sure that your editor is setup with the same file settings. + +--- + +## Contributing as a non-developer/non-designer + +We're always looking for new [translations](#translations). + +Of course bug reports, feature requests and [documentation](https://docs.cachethq.io) are always appreciated. + +## Contributing as a designer + +As Cachet gains new features, the design and ideas that were once a perfect fit need updating and in some cases designing from scratch. This is where you come in! Fancy giving Cachet a lick of paint? Sweet! + +You'll need to install Node.js, Bower and Gulp. + +To get started you can do the following: + +1. Install Node.js and our dev dependencies. +2. Run `gulp` +3. Make your changes to the SCSS files in `./resources/assets/sass/` + +If you're making a lot of changes, you'll find that running `gulp watch` will make life easier for you! + +When you're happy with your changes, please run `gulp --production` to minify the assets. + +## Contributing as a developer + +Built using [Laravel](https://laravel.com). + +We use these extra dependencies to develop Cachet: + +- Node.js +- Gulp +- Git + +Once cloned to your local machine, you'll need some demo data! Run `php artisan cachet:seed` to get the demo installation ready for action. diff --git a/README.md b/README.md index 52eadbf9..939e5d38 100644 --- a/README.md +++ b/README.md @@ -1,73 +1,37 @@ -# Cachet +

+

[![StyleCI](https://styleci.io/repos/26730195/shield)](https://styleci.io/repos/26730195/) [![Build Status](https://img.shields.io/travis/CachetHQ/Cachet/2.4.svg?style=flat-square)](https://travis-ci.org/CachetHQ/Cachet) [![Software License](https://img.shields.io/badge/license-BSD3-brightgreen.svg?style=flat-square)](LICENSE) [![Crowdin](https://d322cqt584bo4o.cloudfront.net/cachet/localized.svg)](http://translate.cachethq.io/project/cachet) [![Latest Release](https://img.shields.io/github/release/cachethq/cachet.svg?style=flat-square)](https://github.com/CachetHQ/Cachet/releases) - -![Screenshot](https://cachethq.io/img/main-interface.jpg) +

Cachet is a beautiful and powerful open source status page system. -## Features +## Overview -- List your services components -- Log incidents -- Apply custom CSS to the status page +- List your service components +- Report incidents +- Customise the look of your status page - Markdown support for incident messages -- JSON API -- Translated into eleven languages +- A powerful JSON API - Metrics -- Cross-database support: MySQL, PostgreSQL and SQLite -- Subscriber notifications via Email -- Two factor authentication using Google Authenticator +- Multi-lingual +- Subscriber notifications via email +- Two factor authentication ## Requirements - PHP 5.5.9+ or newer - HTTP server with PHP support (eg: Apache, Nginx, Caddy) - [Composer](https://getcomposer.org) - -## I'm looking to contribute to this awesome project! - -Sweet, we're always looking for contributions that improve Cachet! It's easy to get started and you don't even need to know how to write a single line of code! - -### Contributing as a non-developer/non-designer - -We're always looking for new [translations](#translations). - -Of course bug reports, feature requests and [documentation](https://docs.cachethq.io) are always appreciated. - -### Contributing as a designer - -As Cachet gains new features, the design and ideas that were once a perfect fit need updating and in some cases designing from scratch. This is where you come in! Fancy giving Cachet a lick of paint? Sweet! - -You'll need to install Node.js, Bower and Gulp. - -To get started you can do the following: - -1. Install Node.js and our dev dependencies. -2. Make your changes to the SCSS files in `./resources/assets/sass/` -3. Run `gulp` - -If you're making a lot of changes, you'll find that running `gulp watch` will make life easier for you! - -### Contributing as a developer - -Built using [Laravel](https://laravel.com). - -We use these extra dependencies to develop Cachet: - -- Node.js -- Gulp -- Git - -Once cloned to your local machine, you'll need some demo data! Run `php artisan cachet:seed` to get the demo installation ready for action. +- A supported database: MySQL, PostgreSQL or SQLite ## Installation, Upgrades and Documentation -Documentation is found at [https://docs.cachethq.io](https://docs.cachethq.io). +You can find documentation at [https://docs.cachethq.io](https://docs.cachethq.io). Here are some useful quick links: @@ -81,18 +45,12 @@ To test out the demo, you may login to the [Dashboard](https://demo.cachethq.io/ - **Username:** `test` or `test@test.com` - **Password:** `test123` -The demo is reset every half hour. +> The demo resets every 30 minutes. -## Translations +## Translate Cachet If you'd like to contribute translations, please check out our [CrowdIn project](https://crowdin.com/project/cachet). -> Thank you to our [translators](https://crowdin.com/project/cachet/activity_stream), who have allowed us to share Cachet with the world! - -## Show your support - -Cachet is a BSD-3-licensed open source project. If you'd like to support future development, check out the [Patreon campaign](https://patreon.com/jbrooksuk). - ## Professional Installation Service We offer a professional installation service. To find out more, email us at [support@alt-three.com](mailto:support@alt-three.com?Cachet Installation)