winter/README.md

87 lines
4.9 KiB
Markdown
Raw Normal View History

2015-03-04 18:18:48 +11:00
<p align="center">
<img src="https://github.com/wintercms/winter/raw/develop/modules/backend/assets/images/wordmark.png?raw=true" alt="Winter CMS Logo" width="100%" />
2015-03-04 18:18:48 +11:00
</p>
2015-02-20 18:16:38 +11:00
[Winter](https://wintercms.com) is a Content Management System (CMS) 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
Winter's mission is to show the world that web development is not rocket science.
2013-11-27 12:21:42 +11:00
[![Version](https://img.shields.io/github/v/release/wintercms/winter?sort=semver&style=flat-square)](https://github.com/wintercms/winter/releases)
[![Tests](https://img.shields.io/github/workflow/status/wintercms/winter/Tests/develop?label=tests&style=flat-square)](https://github.com/wintercms/winter/actions)
[![License](https://img.shields.io/github/license/wintercms/winter?label=open%20source&style=flat-square)](https://packagist.org/packages/wintercms/winter)
2021-04-21 16:53:20 -06:00
[![Discord](https://img.shields.io/discord/816852513684193281?label=discord&style=flat-square)](https://discord.gg/D5MFSPH6Ux)
2015-07-25 13:25:48 +10:00
## Installing Winter
2014-05-17 14:40:24 +10:00
Instructions on how to install Winter can be found at the [installation guide](https://wintercms.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 Winter from command line:
2016-07-31 23:45:11 -04:00
```shell
composer create-project wintercms/winter example.com "dev-develop"
2016-06-23 07:37:29 +10:00
```
If you plan on using a database, run this command inside the application directory.
2016-06-23 07:37:29 +10:00
2016-07-31 23:45:11 -04:00
```shell
php artisan winter:install
```
## Learning Winter
2019-08-15 09:09:54 -06:00
2021-04-21 13:56:10 -06:00
The best place to learn Winter is by [reading the documentation](https://wintercms.com/docs), [watching some screencasts](https://octobercms.com/support/topic/screencast) or [following some tutorials](https://octobercms.com/support/articles/tutorials).
2019-08-15 09:09:54 -06:00
You may also watch these introductory videos for [beginners](https://vimeo.com/79963873) and [advanced users](https://vimeo.com/172202661).
2019-08-15 09:09:54 -06:00
## Development Team
2019-08-15 09:09:54 -06:00
Winter was forked from October CMS in March 2021 due to a difference in open source management philosophies between the core maintainer team and the two founders of October.
2019-08-15 09:09:54 -06:00
The development of Winter is lead by [Luke Towers](https://luketowers.ca/), along with many wonderful people that dedicate their time to help support and grow the community.
<table>
<tr>
<td align="center"><a href="https://github.com/luketowers"><img src="https://avatars.githubusercontent.com/u/7253840?v=3" width="100px;" alt="Luke Towers"/><br /><sub><b>Luke Towers</b></sub></a></td>
<td align="center"><a href="https://github.com/bennothommo"><img src="https://avatars.githubusercontent.com/u/15900351?v=3" width="100px;" alt="Ben Thomson"/><br /><sub><b>Ben Thomson</b></sub></a></td>
<td align="center"><a href="https://github.com/mjauvin"><img src="https://avatars.githubusercontent.com/u/2013630?v=3" width="100px;" alt="Marc Jauvin"/><br /><sub><b>Marc Jauvin</b></sub></a></td>
2021-03-13 07:27:49 +00:00
<td align="center"><a href="https://github.com/jaxwilko"><img src="https://avatars.githubusercontent.com/u/31214002?v=4" width="100px;" alt="Jack Wilkinson"/><br /><sub><b>Jack Wilkinson</b></sub></a></td>
</tr>
</table>
## Foundation library
2019-08-15 09:09:54 -06:00
The CMS is built on top of the wildly-popular [Laravel](https://laravel.com) PHP framework, with the in-house [Storm](https://github.com/wintercms/storm) Library as a buffer between the Laravel Framework and the CMS project to minimize breaking changes and improve stability.
2019-08-15 09:09:54 -06:00
## Contact
2019-08-15 09:09:54 -06:00
You can communicate with us using the following mediums:
2019-08-15 09:09:54 -06:00
* [Follow us on Twitter](https://twitter.com/usewintercms) for announcements and updates.
* [Join us on Discord](https://discord.gg/D5MFSPH6Ux) to chat with us.
2019-08-15 09:09:54 -06:00
## Contributing
2013-11-27 12:21:42 +11:00
Before sending or reviewing Pull Requests, be sure to review the [Contributing Guidelines](https://github.com/wintercms/.github/blob/master/CONTRIBUTING.md) first.
2013-11-27 12:23:11 +11:00
### Coding standards
2014-05-15 11:05:49 +10:00
Please follow the following guides and code standards:
2014-05-15 11:05:49 +10:00
* [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)
2013-11-27 12:23:11 +11:00
### Code of Conduct
2013-11-27 16:49:54 +11:00
In order to ensure that the Winter CMS community is welcoming to all, please review and abide by the [Code of Conduct](https://github.com/wintercms/.github/blob/master/CODE_OF_CONDUCT.md).
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
The Winter CMS platform is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).
## Security Vulnerabilities
Please review [our security policy](https://github.com/wintercms/winter/security/policy) on how to report security vulnerabilities.