提交 acb2b57d 编写于 作者: A Aurélien GEORGET 提交者: GitHub

Merge pull request #276 from strapi/alpha.6

Release - 3.0.0-alpha.6

要显示的变更太多。

To preserve performance only 1000 of 1000+ files are displayed.
文件模式从 100644 更改为 100755
文件模式从 100644 更改为 100755
文件模式从 100644 更改为 100755
......@@ -92,6 +92,8 @@ results
build
node_modules
.node_history
package-lock.json
**/package-lock.json
############################
......@@ -102,6 +104,12 @@ testApp
coverage
############################
# Documentation
############################
_book
############################
# Builds
############################
......
......@@ -20,4 +20,5 @@ install:
- npm run setup
script:
- npm run doc
- npm run test
## Contribute to the project
### Open Development & Community Driven
Strapi is open-source under the [MIT license](https://github.com/strapi/strapi/blob/master/LICENSE.md). All the work done is available on GitHub.
The core team and the contributors send pull requests which go through the same validation process.
Every user can send a feature request using the [issues](https://github.com/strapi/strapi/issues) on GitHub.
-----
### Repository Organization
We made the choice to use a monorepo design such as [React](https://github.com/facebook/react/tree/master/packages), [Babel](https://github.com/babel/babel/tree/master/packages), [Meteor](https://github.com/meteor/meteor/tree/devel/packages) or [Ember](https://github.com/emberjs/ember.js/tree/master/packages) do. It allows the community to easily maintain the whole ecosystem up-to-date and consistent.
The Babel team wrotes an excellent short post about [the pros and cons of the monorepo design](https://github.com/babel/babel/blob/master/doc/design/monorepo.md).
We will do our best to keep the master branch clean as possible, with tests passing all the times. However, it can happen that the master branch moves faster than the release cycle. To ensure to use the latest stable version, please refers to the [release on npm](https://www.npmjs.com/package/strapi).
If you send a pull request, please do it again the `master` branch. We are developing upcoming versions separately to ensure non-breaking changes from master to the latest stable major version.
-----
### Setup Development Environment
To facilitate the contribution, we drastically reduce the amount of commands necessary to install the entire development environment. First of all, you need to check if you're using the recommended versions of Node.js (v8) and npm (v5).
**Then, please follow the instructions below:**
1. [Fork the repository](https://github.com/strapi/strapi) to your own GitHub account.
2. Clone it to your computer `git clone git@github.com:strapi/strapi.git`.
3. Run `npm run setup` at the root of the directory.
> Note: If the installation failed, please remove the global packages related to Strapi. The command `npm ls strapi` will help you to find where your packages are installed globally.
The development environment has been installed. Now, you have to create a development project to live-test your updates.
1. Go to a folder on your computer `cd /path/to/my/folder`.
2. Create a new project `strapi new myDevelopmentProject --dev`.
3. Start your app with `strapi start`.
Awesome! You are now able to make bug fixes or enhancements in the framework layer of Strapi. **To make updates in the administration panel, you need to go a little bit further.**
4. Open a new tab or new terminal window.
5. Go to the `/admin` folder of your currently running app.
5. Run `npm start` and go to the following url [http://localhost:4000/admin](http://localhost:4000/admin)
文件模式从 100644 更改为 100755
![Logo](https://cldup.com/7umchwdUBh.png)
<p align="center"><img src="https://cldup.com/7umchwdUBh.png" /></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>
<br />
<p align="center">
<a href="https://www.npmjs.org/package/strapi">
<img src="https://img.shields.io/npm/v/strapi.svg" alt="Dependency Status" />
</a>
<a href="https://www.npmjs.org/package/strapi">
<img src="https://img.shields.io/npm/dm/strapi.svg" alt="Dependency Status" />
</a>
<a href="https://travis-ci.org/strapi/strapi">
<img src="https://travis-ci.org/strapi/strapi.svg?branch=master" alt="Dependency Status" />
</a>
<a href="http://slack.strapi.io">
<img src="http://strapi-slack.herokuapp.com/badge.svg" alt="Dependency Status" />
</a>
</p>
<br>
<p align="center"><img src="http://blog.strapi.io/content/images/2017/07/preview-readme-9.png" /></p>
<br>
## Quick start
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.**.
#### Alpha
The alpha has support for the latest version of Node.js (v8) and npm (v5).
```bash
npm install strapi@alpha -g
```
#### 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
```
Read the [Getting started](http://strapi.io/documentation/getting-started/quick-start.html) page to create your first project using Strapi.
[![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)
[![Build status](https://travis-ci.org/strapi/strapi.svg?branch=master)](https://travis-ci.org/strapi/strapi)
[![Slack status](http://strapi-slack.herokuapp.com/badge.svg)](http://slack.strapi.io)
[Strapi](http://strapi.io) is an open source solution to create, deploy and manage your own API. It provides a powerful dashboard and features to make your life easier.
## v3.0.0 coming soon...
We've been working on a major update to Strapi for several months now, rewriting the core framework and the dashboard. Some parts of this work have been merged into our master branch. Currently, this is not stable and ready.
**Please DON'T use the `master` branch in production. To run and start your current project, we strongly recommend to use the v1.6.3.**
For more information on the upcoming version, please take a look to our [ROADMAP](ROADMAP.md).
Also, we need your opinion about the next features you would like. Please answer our [latest survey about Strapi v3](http://bit.ly/2v7MAdn).
## Features
![Content Manager Plugin - Screenshot](http://blog.strapi.io/content/images/2017/07/preview-readme-9.png)
- **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.
## Why Strapi ?