Skip to content
πŸš€ Open source Node.js Headless CMS to easily build customisable APIs
JavaScript CSS HTML Other
Branch: master
Clone or download
Pull request Compare This branch is 552 commits behind strapi:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
_travis
cypress
docs
examples/getstarted
packages
scripts
test
.editorconfig
.eslintignore
.eslintrc.js
.gitattributes
.gitignore
.gitlab-ci.yml
.prettierignore
.prettierrc.js
.snyk
.travis.yml
CODE_OF_CONDUCT.md
CONTRIBUTING.md
LICENSE.md
Makefile
README.md
babel.config.js
cypress.json
fileTransformer.js
jest.config.e2e.js
jest.config.front.js
jest.config.js
lerna.json
mkdocs.yml
package.json
yarn.lock

README.md

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



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
  • Mac O/S 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.x
  • 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.

This project is currently in Beta. Significant breaking changes are unlikely at this stage of the project, but using the latest version of Strapi ensures you have all the latest features and updates. New releases are usually shipped every two weeks to fix/enhance the project.

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 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.

Try on Heroku

You can also give it a try using Heroku in one click!

Deploy

Be aware that the Content Type Builder won't work due to the restriction of writing files on the Heroku servers. If you would like to change/edit/add Content Types, you need to follow these steps:

  1. Click the button above and deploy your app
  2. Clone that repo by using heroku git:clone -a followed by your repo's name
  3. Go into the cloned projects' folder using cd followed by your repo's name
  4. Add the Heroku boilerplate as a remote by running git remote add boilerplate https://github.com/strapi/strapi-heroku-app
  5. Pull from this new origin by running git pull boilerplate master

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 wiki 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

MIT License Copyright (c) 2015-2019 Strapi Solutions.

You can’t perform that action at this time.