yujunjun/strapi
1
0
Fork 0
mirror of https://github.com/strapi/strapi.git synced 2025-08-20 06:38:46 +00:00
Code Issues Packages Projects Releases Wiki Activity
strapi/docs/.vuepress/dist/assets/js/3.4d92d5e3.js
Jim LAURIE 25ab8e7bef Add base /documentation
2018-10-05 17:24:17 +02:00

1 line
12 KiB
JavaScript
Raw Blame History

(window.webpackJsonp=window.webpackJsonp||[]).push([[3],{236:function(t,e,a){"use strict";a.r(e);var s=a(0),r=Object(s.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("div",{staticClass:"content"},[a("div",{staticClass:"intro custom-block"},[t._m(0),t._v(" "),a("p",[a("a",{attrs:{href:"https://travis-ci.org/wistityhq/strapi",target:"_blank",rel:"noopener noreferrer"}},[a("img",{attrs:{src:"https://travis-ci.org/wistityhq/strapi.svg?branch=master",alt:"Build Status"}}),a("OutboundLink")],1),t._v(" "),a("a",{attrs:{href:"http://slack.strapi.io",target:"_blank",rel:"noopener noreferrer"}},[a("img",{attrs:{src:"http://strapi-slack.herokuapp.com/badge.svg",alt:"Slack Status"}}),a("OutboundLink")],1)]),t._v(" "),a("p",[t._v("Strapi is an open-source Node.js rich framework for building applications and services.")])]),t._v(" "),a("p",[t._v("Strapi enables developers to focus on writing reusable application logic instead of spending time\nbuilding infrastructure. It is designed for building practical, production-ready Node.js applications\nin a matter of hours instead of weeks.")]),t._v(" "),a("p",[t._v("The framework sits on top of "),a("a",{attrs:{href:"http://koajs.com/",target:"_blank",rel:"noopener noreferrer"}},[t._v("Koa"),a("OutboundLink")],1),t._v(". Its ensemble of small modules work\ntogether to provide simplicity, maintainability, and structural conventions to Node.js applications.")]),t._v(" "),t._m(1),t._v(" "),t._m(2),t._v(" "),t._m(3),t._v(" "),a("p",[t._v("Install the latest stable release with the npm command-line tool:")]),t._v(" "),t._m(4),t._m(5),t._v(" "),a("blockquote",[a("p",[t._v("We advise you to use our Studio to build APIs. To do so, you need to create a Strapi account.\n"),a("a",{attrs:{href:"http://studio.strapi.io",target:"_blank",rel:"noopener noreferrer"}},[t._v("Go to the Strapi Studio to signup"),a("OutboundLink")],1),t._v(".\nStudio is dedicated to developers to build applications without writing\nany single line of code thanks to its powerful set of tools.")])]),t._v(" "),a("p",[t._v("After creating an account on the Strapi Studio, you are able to link your machine to your\nStrapi Studio account to get access to all features offered by the Strapi ecosystem.\nUse your Strapi account credentials.")]),t._v(" "),t._m(6),t._m(7),t._v(" "),a("p",[t._v("You now are able to use the Strapi CLI. Simply create your first application and start the server:")]),t._v(" "),t._m(8),t._m(9),t._v(" "),t._m(10),a("p",[t._v("This will generate a Strapi application without:")]),t._v(" "),t._m(11),t._v(" "),a("p",[t._v("This feature allows you to only use Strapi for your HTTP server structure if you want to.")]),t._v(" "),t._m(12),t._v(" "),t._m(13),a("p",[t._v("The default home page is accessible at "),a("a",{attrs:{href:"http://localhost:1337/",target:"_blank",rel:"noopener noreferrer"}},[t._v("http://localhost:1337/"),a("OutboundLink")],1),t._v(".")]),t._v(" "),t._m(14),t._v(" "),a("p",[t._v("The Strapi ecosystem offers you two possibilities to create a complete RESTful API.")]),t._v(" "),t._m(15),t._v(" "),t._m(16),t._m(17),t._v(" "),t._m(18),t._m(19),t._v(" "),a("p",[t._v("The Strapi Studio allows you to easily build and manage your application environment\nthanks to a powerful User Interface.")]),t._v(" "),a("p",[t._v("Log into the Strapi Studio with your user account ("),a("a",{attrs:{href:"http://studio.strapi.io",target:"_blank",rel:"noopener noreferrer"}},[t._v("http://studio.strapi.io"),a("OutboundLink")],1),t._v(")\nand follow the instructions to start the experience.")]),t._v(" "),t._m(20),t._v(" "),t._m(21),t._v(" "),a("p",[t._v("Strapi comes with a simple but yet powerful dashboard.")]),t._v(" "),t._m(22),t._v(" "),t._m(23),t._v(" "),t._m(24),t._v(" "),t._m(25),t._v(" "),t._m(26),t._v(" "),a("ul",[a("li",[a("a",{attrs:{href:"https://strapi.io/",target:"_blank",rel:"noopener noreferrer"}},[t._v("Strapi website"),a("OutboundLink")],1)]),t._v(" "),a("li",[a("a",{attrs:{href:"https://twitter.com/strapijs",target:"_blank",rel:"noopener noreferrer"}},[t._v("Strapi news on Twitter"),a("OutboundLink")],1)])])])},[function(){var t=this.$createElement,e=this._self._c||t;return e("h1",{attrs:{id:"strapi"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#strapi","aria-hidden":"true"}},[this._v("#")]),this._v(" Strapi")])},function(){var t=this.$createElement,e=this._self._c||t;return e("p",[e("strong",[this._v("DISCLAIMER")]),this._v(": "),e("em",[this._v("This version is maintained for criticals issues only")]),this._v(".")])},function(){var t=this.$createElement,e=this._self._c||t;return e("h2",{attrs:{id:"getting-started-in-a-minute"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getting-started-in-a-minute","aria-hidden":"true"}},[this._v("#")]),this._v(" Getting started in a minute")])},function(){var t=this.$createElement,e=this._self._c||t;return e("h3",{attrs:{id:"installation"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#installation","aria-hidden":"true"}},[this._v("#")]),this._v(" Installation")])},function(){var t=this.$createElement,e=this._self._c||t;return e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[this._v("$ "),e("span",{attrs:{class:"token function"}},[this._v("npm")]),this._v(" "),e("span",{attrs:{class:"token function"}},[this._v("install")]),this._v(" strapi -g\n")])])])},function(){var t=this.$createElement,e=this._self._c||t;return e("h3",{attrs:{id:"link-to-the-strapi-studio"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#link-to-the-strapi-studio","aria-hidden":"true"}},[this._v("#")]),this._v(" Link to the Strapi Studio")])},function(){var t=this.$createElement,e=this._self._c||t;return e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[this._v("$ strapi login\n")])])])},function(){var t=this.$createElement,e=this._self._c||t;return e("h3",{attrs:{id:"create-your-first-project"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#create-your-first-project","aria-hidden":"true"}},[this._v("#")]),this._v(" Create your first project")])},function(){var t=this.$createElement,e=this._self._c||t;return e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[this._v("$ strapi new "),e("span",{attrs:{class:"token operator"}},[this._v("<")]),this._v("appName"),e("span",{attrs:{class:"token operator"}},[this._v(">")]),this._v("\n")])])])},function(){var t=this.$createElement,e=this._self._c||t;return e("p",[this._v("Note that you can generate a dry application using the "),e("code",[this._v("dry")]),this._v(" option:")])},function(){var t=this.$createElement,e=this._self._c||t;return e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[this._v("$ strapi new "),e("span",{attrs:{class:"token operator"}},[this._v("<")]),this._v("appName"),e("span",{attrs:{class:"token operator"}},[this._v(">")]),this._v(" --dry\n")])])])},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ul",[a("li",[t._v("the built-in "),a("code",[t._v("user")]),t._v(", "),a("code",[t._v("email")]),t._v(" and "),a("code",[t._v("upload")]),t._v(" APIs,")]),t._v(" "),a("li",[t._v("the "),a("code",[t._v("grant")]),t._v(" hook,")]),t._v(" "),a("li",[t._v("the open-source admin panel,")]),t._v(" "),a("li",[t._v("the Waterline ORM ("),a("code",[t._v("waterline")]),t._v(" and "),a("code",[t._v("blueprints")]),t._v(" hooks disabled),")]),t._v(" "),a("li",[t._v("the Strapi Studio connection ("),a("code",[t._v("studio")]),t._v(" hook disabled).")])])},function(){var t=this.$createElement,e=this._self._c||t;return e("h3",{attrs:{id:"start-your-application"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#start-your-application","aria-hidden":"true"}},[this._v("#")]),this._v(" Start your application")])},function(){var t=this.$createElement,e=this._self._c||t;return e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[this._v("$ "),e("span",{attrs:{class:"token function"}},[this._v("cd")]),this._v(" "),e("span",{attrs:{class:"token operator"}},[this._v("<")]),this._v("appName"),e("span",{attrs:{class:"token operator"}},[this._v(">")]),this._v("\n$ strapi start\n")])])])},function(){var t=this.$createElement,e=this._self._c||t;return e("h3",{attrs:{id:"create-your-first-api"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#create-your-first-api","aria-hidden":"true"}},[this._v("#")]),this._v(" Create your first API")])},function(){var t=this.$createElement,e=this._self._c||t;return e("h4",{attrs:{id:"via-the-cli"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#via-the-cli","aria-hidden":"true"}},[this._v("#")]),this._v(" Via the CLI")])},function(){var t=this.$createElement,e=this._self._c||t;return e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[this._v("$ strapi generate api "),e("span",{attrs:{class:"token operator"}},[this._v("<")]),this._v("apiName"),e("span",{attrs:{class:"token operator"}},[this._v(">")]),this._v("\n")])])])},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("p",[t._v("For example, you can create a "),a("code",[t._v("car")]),t._v(" API with a name ("),a("code",[t._v("name")]),t._v("), year ("),a("code",[t._v("year")]),t._v(") and\nthe license plate ("),a("code",[t._v("license")]),t._v(") with:")])},function(){var t=this.$createElement,e=this._self._c||t;return e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[this._v("$ strapi generate api car name:string year:integer license:string\n")])])])},function(){var t=this.$createElement,e=this._self._c||t;return e("h4",{attrs:{id:"via-the-strapi-studio"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#via-the-strapi-studio","aria-hidden":"true"}},[this._v("#")]),this._v(" Via the Strapi Studio")])},function(){var t=this.$createElement,e=this._self._c||t;return e("p",[e("img",{attrs:{src:"http://strapi.io/assets/screenshots/studio.png",alt:"Strapi Studio",title:"Strapi Studio"}}),this._v(" "),e("em",[this._v("Simply manage your APIs and relations thanks to the Strapi Studio.")])])},function(){var t=this.$createElement,e=this._self._c||t;return e("h2",{attrs:{id:"manage-your-data"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#manage-your-data","aria-hidden":"true"}},[this._v("#")]),this._v(" Manage your data")])},function(){var t=this.$createElement,e=this._self._c||t;return e("p",[e("img",{attrs:{src:"http://strapi.io/assets/screenshots/create.png",alt:"Strapi Dashboard",title:"Strapi Dashboard"}}),this._v(" "),e("em",[this._v("Create, read, update and delete your data.")])])},function(){var t=this.$createElement,e=this._self._c||t;return e("p",[e("img",{attrs:{src:"http://strapi.io/assets/screenshots/permissions.png",alt:"Strapi Dashboard",title:"Strapi Dashboard"}}),this._v(" "),e("em",[this._v("Manage user settings, login, registration, groups and permissions on the fly.")])])},function(){var t=this.$createElement,e=this._self._c||t;return e("h2",{attrs:{id:"resources"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#resources","aria-hidden":"true"}},[this._v("#")]),this._v(" Resources")])},function(){var t=this.$createElement,e=this._self._c||t;return e("ul",[e("li",[e("a",{attrs:{href:"(https://github.com/strapi/strapi/blob/master/CONTRIBUTING.md)"}},[this._v("Contributing guide")])]),this._v(" "),e("li",[e("a",{attrs:{href:"(https://github.com/strapi/strapi/blob/master/LICENSE.md)"}},[this._v("MIT License")])])])},function(){var t=this.$createElement,e=this._self._c||t;return e("h2",{attrs:{id:"links"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#links","aria-hidden":"true"}},[this._v("#")]),this._v(" Links")])}],!1,null,null,null);r.options.__file="README.md";e.default=r.exports}}]);
Reference in New Issue View Git Blame Copy Permalink