We're hiring! Located in Paris 🇫🇷 and dreaming of being full-time on Strapi? Join us!
The most advanced open-source Content Management Framework (headless-CMS) to build powerful API with no effort.
Read the Getting Started tutorial or follow the steps below:
Operating system:
- Ubuntu/Debian
- CentOS/RHEL
- MacOS
- Windows - WSL Only
- Docker - Docker-Repo
Please note that Strapi may work on other Operating Systems, but are not tested at this time.
Node:
- NodeJS >= 10.x
- NPM >= 6.x
Please note that right now Node 11 is not Officially supported, and the current Node LTS (v10) should be used.
Database:
- MongoDB >= 3.x
- MySQL >= 5.6
- MariaDB >= 10.1
- PostgreSQL >= 10
npm install strapi@alpha -g
We recommend to use the latest version of Strapi to start your new project. Some breaking changes might happen, new releases are shipped every two weeks to fix/enhance the product.
strapi new my-project
It will generate a brand new project with the default features (authentication, permissions, content management, content type builder & file upload).
cd my-project
strapi start
Congratulations, you made it! Enjoy 🎉
You can also give it a try using Heroku in one click!
Be aware that one of the content type builder won't work due to the writing files restriction on the Heroku servers. If you do want to change content types, you need to follow these steps:
- Click the button above and deploy your app
- Clone that repo by using
heroku git:clone -a
followed by your repo's name - Go into the cloned projects' folder using
cd
followed by your repo's name - Add the Heroku boilerplate as a remote by running
git remote add boilerplate https://github.com/strapi/strapi-heroku-app
- Pull from this new origin by running
git pull boilerplate master
- 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.
- Powerful CLI: Scaffold projects and APIs on the fly.
- SQL & NoSQL databases: Work with Mongo as a main database, also supports Postgres, MySQL, etc.
Please read our Contributing Guide before submitting a Pull Request to the project.
For more information on the upcoming version, please take a look to our ROADMAP.
For general help using Strapi, please refer to the official Strapi documentation. For additional help, you can use one of this channel to ask question:
- StackOverflow
- Slack (highly recommended for realtime support)
- GitHub
- Facebook.
Strapi Solutions, 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 to see how we can help you.
Follow our migration guides on the wiki to keep your projects up-to-date.
Check out our roadmap to get informed by the latest feature released and the upcoming ones. You can also give us insights and vote for a specific feature.
Become a sponsor and get your logo on our README on GitHub with a link to your site.
MIT License Copyright (c) 2015-2018 Strapi Solutions.