Skip to content

Latest commit

 

History

History
155 lines (109 loc) · 6.36 KB

README.md

File metadata and controls

155 lines (109 loc) · 6.36 KB
Raw

Strapi logo

API creation made simple, secure and fast.

The most advanced open-source headless CMS to build powerful APIs with no effort.


NPM Version Monthly download on NPM Travis Build Status Strapi on Slack


Administration panel


Strapi is a free and open-source headless CMS delivering your content anywhere you need.

  • Keep control over your data. With Strapi, you know where your data is stored, and you keep full control at all times.
  • Self-hosted. You can host and scale Strapi projects the way you want. You can choose any hosting platform you want: AWS, Netlify, Heroku, a VPS, or a dedicated server. You can scale as you grow, 100% independent.
  • Database agnostic. You can choose the database you prefer. Strapi works with SQL & NoSQL databases: MongoDB, PostgreSQL, MySQL, MariaDB, and SQLite.
  • Customizable. You can quickly build your logic by fully customizing APIs, routes, or plugins to fit your needs perfectly.

Getting Started

Read the Getting Started tutorial or follow the steps below:

⏳ Installation

Install Strapi with this Quickstart command to create a Strapi project instantly:

yarn create strapi-app my-project --quickstart

or

  • (Use npm/npx to install the Strapi project.)
npx create-strapi-app my-project --quickstart

This command generates a brand new project with the default features (authentication, permissions, content management, content type builder & file upload). The Quickstart command installs Strapi using a SQLite database which is used for prototyping in development.

Enjoy 🎉

🖐 Requirements

Complete installation requirements can be found in the documentation under Installation Requirements.

Supported operating systems:

  • Ubuntu 18.04/Debian 9.x
  • CentOS/RHEL 8
  • macOS Mojave
  • Windows 10
  • Docker - Docker-Repo

(Please note that Strapi may work on other operating systems, but these are not tested nor officially supported at this time.)

Node:

  • NodeJS >= 10.16 <=14
  • NPM >= 6.x

Database:

  • MongoDB >= 3.6
  • MySQL >= 5.6
  • MariaDB >= 10.1
  • PostgreSQL >= 10
  • SQLite >= 3

We recommend always using the latest version of Strapi to start your new projects.

Features

  • Modern Admin Panel: Elegant, entirely customizable and a fully extensible admin panel.
  • Secure by default: Reusable policies, CORS, CSP, P3P, Xframe, XSS, and more.
  • Plugins Oriented: Install the auth system, content management, custom plugins, and more, in seconds.
  • Blazing Fast: Built on top of Node.js, Strapi delivers amazing performance.
  • Front-end Agnostic: Use any front-end framework (React, Vue, Angular, etc.), mobile apps or even IoT.
  • Powerful CLI: Scaffold projects and APIs on the fly.
  • SQL & NoSQL databases: Works with MongoDB, PostgreSQL, MySQL, MariaDB, and SQLite.

See more on our website.

Contributing

Please read our Contributing Guide before submitting a Pull Request to the project.

Community support

For general help using Strapi, please refer to the official Strapi documentation. For additional help, you can use one of these channels to ask a question:

Migration

Follow our migration guides on the documentation to keep your projects up-to-date.

Roadmap

Check out our roadmap to get informed of the latest features released and the upcoming ones. You may also give us insights and vote for a specific feature.

License

See the LICENSE file for licensing information.