From 5207606c6d27e950a66cf3658ae96705864dd8cf Mon Sep 17 00:00:00 2001 From: DMehaffy Date: Mon, 31 May 2021 02:37:37 -0700 Subject: [PATCH] Update badges and copy README to main Strapi package for NPM (#10398) * Update Readme to remove old badges Removed the old Travis badge and swapped the Slack one for the Discord one * Copy in main README per Victor Signed-off-by: Derrick Mehaffy --- README.md | 7 +- packages/strapi/README.md | 170 +++++++++++++++++++++++++++++++++++--- 2 files changed, 159 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index d0145cec04..ff385c75bf 100644 --- a/README.md +++ b/README.md @@ -33,11 +33,8 @@ Monthly download on NPM - - Travis Build Status - - - Strapi on Slack + + Strapi on Discord

diff --git a/packages/strapi/README.md b/packages/strapi/README.md index de6c609b10..ff385c75bf 100644 --- a/packages/strapi/README.md +++ b/packages/strapi/README.md @@ -1,19 +1,163 @@ -# strapi +

+ + Strapi logo + +

+

API creation made simple, secure and fast.

+

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

+

Try live demo

+
-[![npm version](https://img.shields.io/npm/v/strapi.svg)](https://www.npmjs.org/package/strapi) -[![npm downloads](https://img.shields.io/npm/dm/strapi.svg)](https://www.npmjs.org/package/strapi) -[![npm dependencies](https://david-dm.org/strapi/strapi.svg)](https://david-dm.org/strapi/strapi) -[![Build status](https://travis-ci.org/strapi/strapi.svg?branch=master)](https://travis-ci.org/strapi/strapi) -[![Slack status](https://slack.strapi.io/badge.svg)](https://slack.strapi.io) +

+ + + -The Strapi HTTP layer sits on top of [Koa](http://koajs.com/). Its ensemble of small modules work together to provide simplicity, maintainability, and structural conventions to Node.js applications. + + + -## Resources + + + -- [License](LICENSE) + + + +

-## Links +

+ + NPM Version + + + Monthly download on NPM + + + Strapi on Discord + +

-- [Strapi website](https://strapi.io/) -- [Strapi community on Slack](https://slack.strapi.io) -- [Strapi news on Twitter](https://twitter.com/strapijs) +
+ +

+ + 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, 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 + +Read the Getting Started tutorial or follow the steps below: + +### ⏳ Installation + +Install Strapi with this **Quickstart** command to create a Strapi project instantly: + +- (Use **yarn** to install the Strapi project (recommended). [Install yarn with these docs](https://yarnpkg.com/lang/en/docs/install/).) + +```bash +yarn create strapi-app my-project --quickstart +``` + +**or** + +- (Use npm/npx to install the Strapi project.) + +```bash +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 LTS/Debian 9.x +- CentOS/RHEL 8 +- macOS Mojave +- Windows 10 +- Docker - [Docker-Repo](https://github.com/strapi/strapi-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.strapi.io/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.strapi.io/t/dropping-mongodb-support/) in next major version), PostgreSQL, MySQL, MariaDB, and SQLite. + +**[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. + +## 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 these channels to ask a question: + +- [Discord](https://discord.strapi.io) (For live discussion with the Community and Strapi team) +- [GitHub](https://github.com/strapi/strapi) (Bug reports, Contributions) +- [Community Forum](https://forum.strapi.io) (Questions and Discussions) +- [Academy](https://academy.strapi.io) (Learn the fundamentals of Strapi) +- [ProductBoard](https://portal.productboard.com/strapi/tabs/2-under-consideration) (Roadmap, Feature requests) +- [Twitter](https://twitter.com/strapijs) (Get the news fast) +- [Facebook](https://www.facebook.com/Strapi-616063331867161) +- [YouTube Channel](https://www.youtube.com/strapi) (Learn from Video Tutorials) + +## Migration + +Follow our [migration guides](https://strapi.io/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/strapi) 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/strapi/documentation) for the Strapi documentation, or view our documentation live: + +- [Developer docs](https://strapi.io/documentation/developer-docs/latest/getting-started/introduction.html) +- [User docs](https://strapi.io/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://strapi.io/demo) with sample data. + +## License + +See the [LICENSE](./LICENSE) file for licensing information.