strapi/README.md

72 lines
8.5 KiB
Markdown
Raw Normal View History

2016-01-11 14:33:29 +01:00
# Strapi
[![npm version](https://img.shields.io/npm/v/strapi.svg)](https://www.npmjs.org/package/strapi)
[![npm downloads](https://img.shields.io/npm/dm/strapi.svg)](https://www.npmjs.org/package/strapi)
[![npm dependencies](https://david-dm.org/wistityhq/strapi.svg)](https://david-dm.org/wistityhq/strapi)
[![Build status](https://travis-ci.org/wistityhq/strapi.svg?branch=master)](https://travis-ci.org/wistityhq/strapi)
[![Slack status](http://strapi-slack.herokuapp.com/badge.svg)](http://slack.strapi.io)
2015-10-02 15:47:37 +02:00
2016-03-18 11:12:50 +01:00
[Strapi](http://strapi.io/) is an open-source [Node.js](https://nodejs.org/) rich framework for building applications and services.
2015-10-01 00:30:16 +02:00
2016-03-18 11:12:50 +01:00
[Strapi](http://strapi.io/) enables developers to focus on writing reusable application logic instead of spending time building infrastructure. It is designed for building practical, production-ready Node.js applications in a matter of hours instead of weeks.
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
2016-03-18 11:12:50 +01:00
- **100% JavaScript**, the language you probably already are using for the front-end.
- **Rock-solid foundation** offering plenty of possibilities for web apps and APIs.
- **Useful CLI** that let you scaffold projects, APIs and migrations on the fly.
- **Front-end agnostic** and can be used with Angular, Backbone, React, Ember, Vue, iOS, Android, etc.
- **Easy authentication** with 150+ supported providers to easily manage your authentication processes.
- **Security layers** that just work and ships reusable security policies.
- **GraphQL implementation** for describing data requirements and interactions.
- **JSON API specification** to increase productivity by following shared conventions.
- **Smooth WebSockets** to handle realtime connections and events.
2016-03-22 18:11:11 +01:00
- **Flexible SQL dialect** with schema building for migrations, query building, transactions, and a lot more.
2016-03-18 11:12:50 +01:00
- **Elegant SQL ORM** featuring relations, lifecycle events, etc.
- **NoSQL support** if you need to plug specific data layers.
2015-10-01 00:30:16 +02:00
2016-03-22 18:11:11 +01:00
Convinced? [Get started!](./docs/)
2015-10-01 00:30:16 +02:00
2016-03-22 18:11:11 +01:00
## Support
### Community support
2016-03-22 18:45:53 +01:00
For general help using Strapi, please refer to [the official Strapi documentation](./docs/). For additional help, ask a question on [StackOverflow](http://stackoverflow.com/questions/tagged/strapi).
2015-10-01 00:30:16 +02:00
2016-03-18 11:12:50 +01:00
The community discussions take place [on Slack](http://slack.strapi.io).
2015-10-01 00:30:16 +02:00
2016-03-18 11:12:50 +01:00
When opening [new issues](https://github.com/wistityhq/strapi/issues/new) or commenting on [existing issues](https://github.com/wistityhq/strapi/issues) on [GitHub](https://github.com/wistityhq/strapi), please make sure discussions are related to concrete technical issues of the Strapi framework.
2016-03-18 11:12:50 +01:00
Also, you can follow and ping the Strapi team on [Twitter](https://twitter.com/strapijs) and [Facebook](https://www.facebook.com/Strapi-616063331867161).
2016-03-22 18:11:11 +01:00
### Professional support
[Wistity](http://wistity.co), 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, certifications, customization, etc. [Drop us an email](mailto:support@wistity.co) or [schedule a meeting](https://calendly.com/wistityhq/) to see how we can help you.
2016-03-18 11:12:50 +01:00
## Badge board
2016-03-18 11:12:50 +01:00
| Package | Version | Dependencies | Build |
|---------|---------|--------------|-------|
| [strapi](https://github.com/wistityhq/strapi/tree/master/packages/strapi) | [![npm version](https://img.shields.io/npm/v/strapi.svg)](https://www.npmjs.org/package/strapi) | [![npm dependencies](https://david-dm.org/wistityhq/strapi.svg)](https://david-dm.org/wistityhq/strapi) | [![Build status](https://travis-ci.org/wistityhq/strapi.svg?branch=master)](https://travis-ci.org/wistityhq/strapi) |
| [strapi-bookshelf](https://github.com/wistityhq/strapi/tree/master/packages/strapi-bookshelf) | [![npm version](https://img.shields.io/npm/v/strapi-bookshelf.svg)](https://www.npmjs.org/package/strapi-bookshelf) | [![npm dependencies](https://david-dm.org/wistityhq/strapi-bookshelf.svg)](https://david-dm.org/wistityhq/strapi-bookshelf) | [![Build status](https://travis-ci.org/wistityhq/strapi-bookshelf.svg?branch=master)](https://travis-ci.org/wistityhq/strapi-bookshelf) |
| [strapi-cli](https://github.com/wistityhq/strapi/tree/master/packages/strapi-cli) | [![npm version](https://img.shields.io/npm/v/strapi-cli.svg)](https://www.npmjs.org/package/strapi-cli) | [![npm dependencies](https://david-dm.org/wistityhq/strapi-cli.svg)](https://david-dm.org/wistityhq/strapi-cli) | [![Build status](https://travis-ci.org/wistityhq/strapi-cli.svg?branch=master)](https://travis-ci.org/wistityhq/strapi-cli) |
| [strapi-generate](https://github.com/wistityhq/strapi/tree/master/packages/strapi-generate) | [![npm version](https://img.shields.io/npm/v/strapi-generate.svg)](https://www.npmjs.org/package/strapi-generate) | [![npm dependencies](https://david-dm.org/wistityhq/strapi-generate.svg)](https://david-dm.org/wistityhq/strapi-generate) | [![Build status](https://travis-ci.org/wistityhq/strapi-generate.svg?branch=master)](https://travis-ci.org/wistityhq/strapi-generate) |
| [strapi-generate-api](https://github.com/wistityhq/strapi/tree/master/packages/strapi-generate-api) | [![npm version](https://img.shields.io/npm/v/strapi-generate-api.svg)](https://www.npmjs.org/package/strapi-generate-api) | [![npm dependencies](https://david-dm.org/wistityhq/strapi-generate-api.svg)](https://david-dm.org/wistityhq/strapi-generate-api) | [![Build status](https://travis-ci.org/wistityhq/strapi-generate-api.svg?branch=master)](https://travis-ci.org/wistityhq/strapi-generate-api) |
| [strapi-generate-migrations](https://github.com/wistityhq/strapi/tree/master/packages/strapi-generate-migrations) | [![npm version](https://img.shields.io/npm/v/strapi-generate-migrations.svg)](https://www.npmjs.org/package/strapi-generate-migrations) | [![npm dependencies](https://david-dm.org/wistityhq/strapi-generate-migrations.svg)](https://david-dm.org/wistityhq/strapi-generate-migrations) | [![Build status](https://travis-ci.org/wistityhq/strapi-generate-migrations.svg?branch=master)](https://travis-ci.org/wistityhq/strapi-generate-migrations) |
| [strapi-generate-new](https://github.com/wistityhq/strapi/tree/master/packages/strapi-generate-new) | [![npm version](https://img.shields.io/npm/v/strapi-generate-new.svg)](https://www.npmjs.org/package/strapi-generate-new) | [![npm dependencies](https://david-dm.org/wistityhq/strapi-generate-new.svg)](https://david-dm.org/wistityhq/strapi-generate-new) | [![Build status](https://travis-ci.org/wistityhq/strapi-generate-new.svg?branch=master)](https://travis-ci.org/wistityhq/strapi-generate-new) |
2016-03-25 22:43:42 +01:00
| [strapi-generate-policy](https://github.com/wistityhq/strapi/tree/master/packages/strapi-generate-policy) | [![npm version](https://img.shields.io/npm/v/strapi-generate-policy.svg)](https://www.npmjs.org/package/strapi-generate-policy) | [![npm dependencies](https://david-dm.org/wistityhq/strapi-generate-policy.svg)](https://david-dm.org/wistityhq/strapi-generate-policy) | [![Build status](https://travis-ci.org/wistityhq/strapi-generate-policy.svg?branch=master)](https://travis-ci.org/wistityhq/strapi-generate-policy) |
2016-03-25 22:50:01 +01:00
| [strapi-generate-service](https://github.com/wistityhq/strapi/tree/master/packages/strapi-generate-service) | [![npm version](https://img.shields.io/npm/v/strapi-generate-service.svg)](https://www.npmjs.org/package/strapi-generate-service) | [![npm dependencies](https://david-dm.org/wistityhq/strapi-generate-service.svg)](https://david-dm.org/wistityhq/strapi-generate-service) | [![Build status](https://travis-ci.org/wistityhq/strapi-generate-service.svg?branch=master)](https://travis-ci.org/wistityhq/strapi-generate-service) |
2016-03-18 11:12:50 +01:00
| [strapi-knex](https://github.com/wistityhq/strapi/tree/master/packages/strapi-knex) | [![npm version](https://img.shields.io/npm/v/strapi-knex.svg)](https://www.npmjs.org/package/strapi-knex) | [![npm dependencies](https://david-dm.org/wistityhq/strapi-knex.svg)](https://david-dm.org/wistityhq/strapi-knex) | [![Build status](https://travis-ci.org/wistityhq/strapi-knex.svg?branch=master)](https://travis-ci.org/wistityhq/strapi-knex) |
| [strapi-utils](https://github.com/wistityhq/strapi/tree/master/packages/strapi-utils) | [![npm version](https://img.shields.io/npm/v/strapi-utils.svg)](https://www.npmjs.org/package/strapi-utils) | [![npm dependencies](https://david-dm.org/wistityhq/strapi-utils.svg)](https://david-dm.org/wistityhq/strapi-utils) | [![Build status](https://travis-ci.org/wistityhq/strapi-utils.svg?branch=master)](https://travis-ci.org/wistityhq/strapi-utils) |
2015-10-01 00:30:16 +02:00
2016-03-22 18:11:11 +01:00
## Resources
- [Documentation](./docs)
- [Legal info](./info)
2015-10-01 00:30:16 +02:00
## Links
- [Strapi website](http://strapi.io/)
2016-03-18 11:12:50 +01:00
- [Strapi community on Slack](http://slack.strapi.io)
2015-10-01 00:30:16 +02:00
- [Strapi news on Twitter](https://twitter.com/strapijs)