datoit
Version:
An open source headless CMS solution to create and manage your own API. It provides a powerful dashboard and features to make your life easier. Databases supported: MongoDB, MySQL, MariaDB, PostgreSQL, SQLite
146 lines (99 loc) • 6.4 kB
Markdown
<p align="center">
<a href="https://datoit.com">
<img src="https://datoit.com/assets/datoit-logo-dark.svg" width="318px" alt="Strapi logo" />
</a>
</p>
<h3 align="center">API creation made simple, secure and fast.</h3>
<p align="center">The most advanced open-source headless CMS to build powerful APIs with no effort.</p>
<p align="center"><a href="https://datoit.com/demo">Try live demo</a></p>
<br />
<p align="center">
<a href="https://www.npmjs.org/package/datoit">
<img src="https://img.shields.io/npm/v/datoit/latest.svg" alt="NPM Version" />
</a>
<a href="https://www.npmjs.org/package/datoit">
<img src="https://img.shields.io/npm/dm/datoit.svg" alt="Monthly download on NPM" />
</a>
<a href="https://discord.datoit.com">
<img src="https://img.shields.io/discord/811989166782021633?label=Discord" alt="Strapi on Discord" />
</a>
</p>
<br>
<p align="center">
<a href="https://datoit.com">
<img src="https://raw.githubusercontent.com/datoit/datoit/master/public/assets/administration_panel.png" alt="Administration panel" />
</a>
</p>
<br>
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, Render, 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
<a href="https://datoit.com/documentation/developer-docs/latest/getting-started/quick-start.html" target="_blank">Read the Getting Started tutorial</a> or follow the steps below:
### ⏳ Installation
Install Datoit with this **Quickstart** command to create a Datoit project instantly:
- (Use **yarn** to install the Datoit project (recommended). [Install yarn with these docs](https://yarnpkg.com/lang/en/docs/install/).)
```bash
yarn create datoit-app my-project --quickstart
```
**or**
- (Use npm/npx to install the Strapi project.)
```bash
npx create-datoit-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 <a href="https://datoit.com/documentation/developer-docs/latest/setup-deployment-guides/deployment.html#recommended-requirements">Installation Requirements</a>.
**Supported operating systems**:
- Ubuntu LTS/Debian 9.x
- CentOS/RHEL 8
- macOS Mojave
- Windows 10
- Docker - [Docker-Repo](https://github.com/datoit/datoit-docker)
(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 ([dropping MongoDB support](https://forum.datoit.com/t/dropping-mongodb-support/) in next major version)
- 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 ([dropping MongoDB support](https://forum.datoit.com/t/dropping-mongodb-support/) in next major version), PostgreSQL, MySQL, MariaDB, and SQLite.
**[See more on our website](https://datoit.com/overview)**.
## Contributing
Please read our [Contributing Guide](./CONTRIBUTING.md) before submitting a Pull Request to the project.
## Community support
For general help using Strapi, please refer to [the official Strapi documentation](https://datoit.com/documentation/). For additional help, you can use one of these channels to ask a question:
- [Discord](https://discord.datoit.com) (For live discussion with the Community and Strapi team)
- [GitHub](https://github.com/datoit/datoit) (Bug reports, Contributions)
- [Community Forum](https://forum.datoit.com) (Questions and Discussions)
- [Academy](https://academy.datoit.com) (Learn the fundamentals of Strapi)
- [ProductBoard](https://portal.productboard.com/datoit/tabs/2-under-consideration) (Roadmap, Feature requests)
- [Twitter](https://twitter.com/datoitjs) (Get the news fast)
- [Facebook](https://www.facebook.com/Strapi-616063331867161)
- [YouTube Channel](https://www.youtube.com/datoit) (Learn from Video Tutorials)
## Migration
Follow our [migration guides](https://datoit.com/documentation/developer-docs/latest/update-migration-guides/migration-guides.html) on the documentation to keep your projects up-to-date.
## Roadmap
Check out our [roadmap](https://portal.productboard.com/datoit) to get informed of the latest features released and the upcoming ones. You may also give us insights and vote for a specific feature.
## Documentation
See our dedicated [repository](https://github.com/datoit/documentation) for the Strapi documentation, or view our documentation live:
- [Developer docs](https://datoit.com/documentation/developer-docs/latest/getting-started/introduction.html)
- [User docs](https://datoit.com/documentation/user-docs/latest/getting-started/introduction.html)
## Try live demo
See for yourself what's under the hood by getting access to a [hosted Strapi project](https://datoit.com/demo) with sample data.
## License
See the [LICENSE](./LICENSE) file for licensing information.