mirror of
https://github.com/strapi/strapi.git
synced 2025-12-28 23:57:32 +00:00
Update README with Requirements
This commit is contained in:
DMehaffy
parent
1c7492975c
commit
255ae10976
96
README.md
96
README.md
@ -1,6 +1,17 @@
|
||||
<p align="center"><img src="https://blog.strapi.io/content/images/2017/10/logo.png" width="318px" /></p>
|
||||
<p align="center">
|
||||
<strong>We're hiring!</strong> Located in Paris 🇫🇷 and dreaming of being full-time on Strapi?
|
||||
<a href="https://strapi.io/company#looking-for-talents">Join us</a>!
|
||||
</p>
|
||||
|
||||
---
|
||||
|
||||
<p align="center">
|
||||
<a href="https://strapi.io">
|
||||
<img src="https://blog.strapi.io/content/images/2017/10/logo.png" 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 Content Management Framework to build powerful API with no effort.</p>
|
||||
<p align="center">The most advanced open-source Content Management Framework (headless-CMS) to build powerful API with no effort.</p>
|
||||
<br />
|
||||
<p align="center">
|
||||
<a href="https://www.npmjs.org/package/strapi">
|
||||
@ -19,27 +30,19 @@
|
||||
|
||||
<br>
|
||||
|
||||
<p align="center"><img src="https://blog.strapi.io/content/images/2017/10/Github-Preview.png" /></p>
|
||||
<p align="center">
|
||||
<a href="https://strapi.io">
|
||||
<img src="https://blog.strapi.io/content/images/2018/08/github_preview-2.png" />
|
||||
</a>
|
||||
</p>
|
||||
|
||||
<br>
|
||||
|
||||
## Quick start
|
||||
## Getting Started
|
||||
|
||||
We've been working on a major update to Strapi for several months now, rewriting the core framework and the administration panel. Performances has been increased, Developer eXperience has been improved and a brand new plugins
|
||||
ecosystem has been introduced. **Both versions are available, we still recommend you to use v1 for production usage.**.
|
||||
<a href="https://strapi.io/getting-started)" target="_blank">Read the Getting Started tutorial</a> or follow the steps below:
|
||||
|
||||
<a href="https://heroku.com/deploy?template=https://github.com/strapi/strapi-heroku-app">
|
||||
<img src="https://www.herokucdn.com/deploy/button.svg" alt="Deploy">
|
||||
</a>
|
||||
|
||||
#### Alpha
|
||||
|
||||
The alpha has support for the latest version of Node.js (v10) and npm (v6).
|
||||
```bash
|
||||
npm install strapi@alpha -g
|
||||
```
|
||||
|
||||
##### Requirements
|
||||
#### Requirements
|
||||
|
||||
Node:
|
||||
* NodeJS >= 10.x
|
||||
@ -51,15 +54,42 @@ Database:
|
||||
* MariaDB >= 10.1
|
||||
* PostgreSQL >= 10
|
||||
|
||||
#### ⏳ Installation
|
||||
|
||||
|
||||
#### Stable
|
||||
This is the production-ready version of Strapi (v1). You should also consider that the migration to v3 will not be easy due to many breaking changes.
|
||||
```bash
|
||||
npm install strapi -g
|
||||
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
|
||||
```
|
||||
|
||||
Read the [Getting started](https://strapi.io/getting-started) page to create your first project using Strapi.
|
||||
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 🎉
|
||||
|
||||
<br>
|
||||
|
||||
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.
|
||||
|
||||
<a href="https://heroku.com/deploy?template=https://github.com/strapi/strapi-heroku-app">
|
||||
<img src="https://www.herokucdn.com/deploy/button.svg" alt="Deploy">
|
||||
</a>
|
||||
|
||||
<br>
|
||||
|
||||
|
||||
## Features
|
||||
|
||||
@ -72,19 +102,17 @@ Read the [Getting started](https://strapi.io/getting-started) page to create you
|
||||
- **Powerful CLI:** Scaffold projects and APIs on the fly.
|
||||
- **SQL & NoSQL databases:** Work with Mongo as a main database, also supports Postgres, MySQL, etc.
|
||||
|
||||
## Philosophy ?
|
||||
**[See more on our website](https://strapi.io/overview)**
|
||||
|
||||
> At [Strapi](https://strapi.io), everything we do we believe in changing the status quo of web development. Our products are simple to use, user friendly and production-ready.
|
||||
## Contributing
|
||||
|
||||
Web and mobile applications needed a powerful, simple to use and production-ready API-driven solution. That's why we created Strapi, an open-source Content Management Framework (CMF) for exposing your content (data, media) accross multi-devices.
|
||||
|
||||
Halfway between a CMS and a framework, Strapi takes advantages of both worlds. A powerful dashboard to easily manage your content with a flexible framework layer to develop and integrate specific features.
|
||||
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
|
||||
#### 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:
|
||||
|
||||
@ -94,13 +122,15 @@ For general help using Strapi, please refer to [the official Strapi documentatio
|
||||
- [Twitter](https://twitter.com/strapijs)
|
||||
- [Facebook](https://www.facebook.com/Strapi-616063331867161).
|
||||
|
||||
### Professional support
|
||||
#### 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.
|
||||
[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.
|
||||
|
||||
### Migration
|
||||
[Drop us an email](mailto:support@strapi.io) to see how we can help you.
|
||||
|
||||
Follow our [migration guides](https://github.com/strapi/strapi/wiki) on the wiki to keep your Strapi projects updated.
|
||||
## Migration
|
||||
|
||||
Follow our [migration guides](https://github.com/strapi/strapi/wiki) on the wiki to keep your projects up-to-date.
|
||||
|
||||
## License
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user