strapi/README.md

94 lines
4.4 KiB
Markdown
Raw Normal View History

2017-10-23 18:16:04 +02:00
<p align="center"><img src="https://blog.strapi.io/content/images/2017/10/logo.png" width="318px" /></p>
2017-09-29 11:29:17 +02:00
<h3 align="center">API creation made simple, secure and fast.</h3>
<p align="center">The most advanced open-source Content Management Framework to build powerful API with no effort.</p>
<br />
<p align="center">
<a href="https://www.npmjs.org/package/strapi">
<img src="https://img.shields.io/npm/v/strapi.svg" alt="Dependency Status" />
</a>
<a href="https://www.npmjs.org/package/strapi">
<img src="https://img.shields.io/npm/dm/strapi.svg" alt="Dependency Status" />
</a>
<a href="https://travis-ci.org/strapi/strapi">
<img src="https://travis-ci.org/strapi/strapi.svg?branch=master" alt="Dependency Status" />
</a>
<a href="http://slack.strapi.io">
<img src="http://strapi-slack.herokuapp.com/badge.svg" alt="Dependency Status" />
</a>
</p>
2016-01-11 14:33:29 +01:00
2017-09-29 11:29:17 +02:00
<br>
2016-12-05 18:43:03 +01:00
2017-10-23 18:15:26 +02:00
<p align="center"><img src="https://blog.strapi.io/content/images/2017/10/Github-Preview.png" /></p>
2016-08-16 11:42:48 +02:00
2017-09-29 14:20:17 +02:00
<br>
2016-08-16 11:42:48 +02:00
2017-09-29 14:20:17 +02:00
## Quick start
2017-07-26 17:16:44 +02:00
2017-09-29 14:20:17 +02:00
We've been working on a major update to Strapi for several months now, rewriting the core framework and the administration panel. Performances has been increased, Developer eXperience has been improved and a brand new plugins
2017-09-29 14:30:51 +02:00
ecosystem has been introduced. **Both versions are available, we still recommend you to use v1 for production usage.**.
2016-08-16 11:42:48 +02:00
2018-02-12 14:35:53 +01:00
<a href="https://heroku.com/deploy?template=https://github.com/strapi/strapi-heroku-app">
<img src="https://www.herokucdn.com/deploy/button.svg" alt="Deploy">
</a>
2017-09-29 14:20:17 +02:00
#### Alpha
2016-03-25 23:00:05 +01:00
The alpha has support for the latest version of Node.js (v9) and npm (v5).
2017-09-29 14:20:17 +02:00
```bash
npm install strapi@alpha -g
```
2016-03-25 23:00:05 +01:00
2017-09-29 14:20:17 +02:00
#### Stable
2017-09-29 14:30:51 +02:00
This is the production-ready version of Strapi (v1). You should also consider that the migration to v3 will not be easy due to many breaking changes.
2017-09-29 14:20:17 +02:00
```bash
npm install strapi -g
```
2016-03-25 23:00:05 +01:00
Read the [Getting started](https://strapi.io/getting-started) page to create your first project using Strapi.
2015-10-01 00:30:16 +02:00
2016-03-18 11:12:50 +01:00
## Features
2015-10-01 00:30:16 +02:00
2017-09-29 14:30:51 +02:00
- **Modern Admin Panel:**
Elegant, entirely customizable and fully extensible admin panel.
- **Secure by default:** Reusable policies, CSRF, CORS, P3P, Xframe, XSS, and more.
- **Plugins Oriented:** Install auth system, content management, custom plugins, and more, in seconds.
- **Blazing Fast:** Built on top of Node.js, Strapi delivers amazing performances.
- **Front-end Agnostic:** Use any front-end frameworks (React, Vue, Angular, etc.), mobile apps or even IoT.
2017-09-29 14:20:17 +02:00
- **Powerful CLI:** Scaffold projects and APIs on the fly.
2017-09-29 14:30:51 +02:00
- **SQL & NoSQL databases:** Work with Mongo as a main database, also supports Postgres, MySQL, etc.
2017-09-29 14:20:17 +02:00
## Philosophy ?
> At [Strapi](https://strapi.io), everything we do we believe in changing the status quo of web development. Our products are simple to use, user friendly and production-ready.
2016-08-15 12:43:36 +02:00
2017-09-29 14:20:17 +02:00
Web and mobile applications needed a powerful, simple to use and production-ready API-driven solution. That's why we created Strapi, an open-source Content Management Framework (CMF) for exposing your content (data, media) accross multi-devices.
2016-08-15 12:43:36 +02:00
2017-09-29 14:20:17 +02:00
Halfway between a CMS and a framework, Strapi takes advantages of both worlds. A powerful dashboard to easily manage your content with a flexible framework layer to develop and integrate specific features.
2015-10-01 00:30:16 +02:00
2016-03-22 18:11:11 +01:00
## Support
2017-09-29 14:20:17 +02:00
For more information on the upcoming version, please take a look to our [ROADMAP](ROADMAP.md).
2016-03-22 18:11:11 +01:00
### Community support
2017-10-13 17:06:18 +02:00
For general help using Strapi, please refer to [the official Strapi documentation](https://strapi.io/documentation/). For additional help, you can use one of this channel to ask question:
2015-10-01 00:30:16 +02:00
2016-12-05 18:43:03 +01:00
- [StackOverflow](http://stackoverflow.com/questions/tagged/strapi)
- [Slack](http://slack.strapi.io) (highly recommended for realtime support)
- [GitHub](https://github.com/strapi/strapi)
- [Twitter](https://twitter.com/strapijs)
- [Facebook](https://www.facebook.com/Strapi-616063331867161).
2016-03-22 18:11:11 +01:00
### Professional support
[Strapi Solutions](https://strapi.io), the company behind Strapi, provides a full range of solutions to get better results, faster. We're always looking for the next challenge: coaching, consulting, training, customization, etc. [Drop us an email](mailto:support@strapi.io) to see how we can help you.
### Migration
Follow our [migration guides](https://strapi.io/documentation/migration/migration-guide.html) on the website to keep your Strapi projects updated.
2016-09-28 11:21:41 +02:00
## License
[MIT License](LICENSE.md) Copyright (c) 2015-2018 [Strapi Solutions](https://strapi.io/).