winter/README.md

76 lines
3.6 KiB
Markdown
Raw Normal View History

2015-03-04 18:18:48 +11:00
<p align="center">
2015-07-25 13:25:48 +10:00
<img src="https://github.com/octobercms/october/blob/master/themes/demo/assets/images/october.png?raw=true" alt="October" width="25%" height="25%" />
2015-03-04 18:18:48 +11:00
</p>
2015-02-20 18:16:38 +11:00
2019-08-15 09:09:54 -06:00
[October](https://octobercms.com) is a Content Management Framework (CMF) and web platform whose sole purpose is to make your development workflow simple again. It was born out of frustration with existing systems. We feel building websites has become a convoluted and confusing process that leaves developers unsatisfied. We want to turn you around to the simpler side and get back to basics.
2013-11-26 15:30:43 -08:00
2013-11-27 12:21:42 +11:00
October's mission is to show the world that web development is not rocket science.
2015-07-25 13:25:48 +10:00
[![Build Status](https://travis-ci.org/octobercms/october.svg?branch=develop)](https://travis-ci.org/octobercms/october)
[![License](https://poser.pugx.org/october/october/license.svg)](https://packagist.org/packages/october/october)
2019-08-15 09:09:54 -06:00
## Installing October
2014-05-17 14:40:24 +10:00
2018-04-16 01:17:42 -06:00
Instructions on how to install October can be found at the [installation guide](https://octobercms.com/docs/setup/installation).
2014-05-17 14:40:24 +10:00
### Quick start installation
For advanced users, run this in your terminal to install October from command line:
2016-07-31 23:45:11 -04:00
```shell
2016-06-24 06:28:21 +10:00
php -r "eval('?>'.file_get_contents('https://octobercms.com/api/installer'));"
2016-06-23 07:37:29 +10:00
```
If you plan on using a database, run this command:
2016-07-31 23:45:11 -04:00
```shell
php artisan october:install
```
2019-08-15 09:09:54 -06:00
## Learning October
The best place to learn October is by [reading the documentation](https://octobercms.com/docs) or [following some tutorials](https://octobercms.com/support/articles/tutorials).
You may also watch these introductory videos for [beginners](https://vimeo.com/79963873) and [advanced users](https://vimeo.com/172202661). There is also the excellent video series by [Watch & Learn](https://watch-learn.com/series/making-websites-with-october-cms).
## Contributing
Before sending a Pull Request, be sure to review the [Contributing Guidelines](.github/CONTRIBUTING.md) first.
## Coding standards
Please follow the following guides and code standards:
* [PSR 4 Coding Standards](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-4-autoloader.md)
* [PSR 2 Coding Style Guide](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)
* [PSR 1 Coding Standards](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-1-basic-coding-standard.md)
## Code of Conduct
In order to ensure that the OctoberCMS community is welcoming to all, please review and abide by the [Code of Conduct](CODE_OF_CONDUCT.md).
## Security Vulnerabilities
Please review [our security policy](https://github.com/octobercms/october/security/policy) on how to report security vulnerabilities.
## Development Team
2013-11-27 12:21:42 +11:00
2019-08-10 09:28:14 -06:00
October was created by [Alexey Bobkov](http://ca.linkedin.com/pub/aleksey-bobkov/2b/ba0/232) and [Samuel Georges](https://www.linkedin.com/in/samuel-georges-0a964131/). The core maintainer is [Luke Towers](https://luketowers.ca/) and other maintainers include [Ben Thomson](https://github.com/bennothommo) and [Denis Denisov](https://github.com/w20k).
2013-11-27 12:23:11 +11:00
2019-08-15 09:09:54 -06:00
## Foundation library
2014-05-15 11:05:49 +10:00
2018-04-16 01:17:42 -06:00
The CMS uses [Laravel](https://laravel.com) as a foundation PHP framework.
2014-05-15 11:05:49 +10:00
2019-08-15 09:09:54 -06:00
## Contact
2013-11-27 12:23:11 +11:00
You can communicate with us using the following mediums:
2013-11-27 16:49:54 +11:00
2018-04-16 01:17:42 -06:00
* [Follow us on Twitter](https://twitter.com/octobercms) for announcements and updates.
* [Follow us on Facebook](https://facebook.com/octobercms) for announcements and updates.
* [Join us on Slack](https://octobercms-slack.herokuapp.com/) to chat with us.
2019-08-10 09:28:14 -06:00
* [Join us on IRC](https://octobercms.com/chat) to chat with us.
2014-05-16 09:07:27 +10:00
2019-08-15 09:09:54 -06:00
## License
2014-05-16 09:07:27 +10:00
2018-04-16 01:17:42 -06:00
The OctoberCMS platform is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).