We're hiring! Located in Paris 🇫🇷 and dreaming of being full-time on Strapi?
Join us!
---
API creation made simple, secure and fast.
The most advanced open-source Content Management Framework (headless-CMS) to build powerful API with no effort.
## Getting Started
Read the Getting Started tutorial or follow the steps below:
#### 🖐 Requirements
Node:
* NodeJS >= 10.x
* NPM >= 6.x
Database:
* MongoDB >= 3.x
* MySQL >= 5.6
* MariaDB >= 10.1
* PostgreSQL >= 10
#### ⏳ Installation
```bash
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.
#### 🏗 Create a new project
```bash
strapi new my-project
```
It will generate a brand new project with the default features (authentication, permissions, content management, content type builder & file upload).
#### 🚀 Start your project
```bash
cd my-project
strapi start
```
Congratulations, you made it! Enjoy 🎉
You can also give it a try using Heroku! Be aware that one of the content type builder won't work due to the writing files restriction on the Heroku servers.
## Features
- **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.
**[See more on our website](https://strapi.io/overview)**
## Contributing
Please read our [Contributing Guide](./CONTRIBUTING.md) before submitting a Pull Request to the project.
## Support
For more information on the upcoming version, please take a look to our [ROADMAP](https://github.com/strapi/strapi/projects).
#### Community support
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:
- [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).
#### 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://github.com/strapi/strapi/wiki) on the wiki to keep your projects up-to-date.
## License
[MIT License](LICENSE.md) Copyright (c) 2015-2018 [Strapi Solutions](https://strapi.io/).