yujunjun/strapi
1
0
Fork 0
mirror of https://github.com/strapi/strapi.git synced 2025-12-27 15:13:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

additional clarifications and typo fixes

Browse Source
This commit is contained in:
davidkartuzinski 2019-06-19 18:54:23 +02:00
parent 02e1ee1d87
commit d8102821e5
2 changed files with 35 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

59
docs/3.0.0-alpha.x/getting-started/quick-start.md
View File

@ -6,7 +6,7 @@ Get ready to make Strapi up and running in **less than 5 minutes** 🚀
<iframe width="800" height="450" src="https://www.youtube.com/embed/nux0djdHmY8" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>
*For a step-by-step guide, please take a look at the [detailed tutorial](quick-start-tutorial.html).*
_For a step-by-step guide, please take a look at the [detailed tutorial](quick-start-tutorial.html)._
## 1. Install Strapi globally
@ -26,53 +26,54 @@ strapi new cms --quickstart
Navigate to [**http://localhost:1337/admin**](http://localhost:1337/admin).
- Fill in the form.
- Click **Ready to start**.
- Fill in the form.
- Click **Ready to start**.
## 4. Create a Content Type
Navigate to [**PLUGINS** - **Content Type Builder**](http://localhost:1337/admin/plugins/content-type-builder).
- Click the **"+ Add Content Type"** button.
- Enter `restaurant`.
- Click **"+ Add New Field"**
- Click the **String** field.
- Type `name` under the **BASE SETTINGS** tab, in the **Name** field.
- Click **Continue**.
- Click **"+ Add New Field"**
- Click the **Text** field.
- Type `description` under the **BASE SETTINGS** tab, in the **Name** field.
- Click the **ADVANCED SETTINGS** tab, check **Display as a WYSIWYG**.
- Click **Continue**.
- Click the **Save** button and wait for Strapi to restart.
- Click the **"+ Add Content Type"** button.
- Enter `restaurant`.
- Click **"+ Add New Field"**
- Click the **String** field.
- Type `name` under the **BASE SETTINGS** tab, in the **Name** field.
- Click **Continue**.
- Click **"+ Add New Field"**
- Click the **Text** field.
- Type `description` under the **BASE SETTINGS** tab, in the **Name** field.
- Click the **ADVANCED SETTINGS** tab, check **Display as a WYSIWYG**.
- Click **Continue**.
- Click the **Save** button and wait for Strapi to restart.
## 5. Manage and add data to Content Type
Navigate to [**CONTENT TYPES** - **Restaurants**](http://localhost:1337/admin/plugins/content-manager/restaurant?source=content-manager).
- Click on **+ Add New Restaurant** button. Type `Strapi Restaurant` in the **Name** field. Type `Strapi restaurant is a cosy restaurant delivering one of the very fastest and nicest dining experiences in the world, combining nods to tradition with fierce modernity, warmth with daring.` into the **Description** field.
- Click **Save**.
- Click on **+ Add New Restaurant** button. Type `Strapi Restaurant` in the **Name** field. Type `Strapi restaurant is a cosy restaurant delivering one of the very fastest and nicest dining experiences in the world, combining nods to tradition with fierce modernity, warmth with daring.` into the **Description** field.
- Click **Save**.
You will see your restaurant listed in the entries.
You will see your restaurant listed in the entries.
## 6. Set roles and permissions
Navigate to [**PLUGINS** - **Roles & Permission**](http://localhost:1337/admin/plugins/users-permissions/roles).
- Click the **pencil** edit icon to the right of the **Public** Role.
- Scroll down under **Permissions**, find **Restaurant**. Click the checkbox next to **find**.
- Click **Save**.
- Click the **pencil** edit icon to the right of the **Public** Role.
- Scroll down under **Permissions**, find **Restaurant**. Click the checkbox next to **find**.
- Click **Save**.
## 7. Consume the Content Type API
## 7. Consume the Content Type's API
Here we are! The list of **restaurants** is accessible at [`http://localhost:1337/restaurants`](http://localhost:1337/restaurants).
::: tip CONGRATULATIONS
👏 Congratulations, you have now completed the Strapi Quick Start. Where to go next?
- Learn how to use Strapi with React ([Gatsby](https://blog.strapi.io/building-a-static-website-using-gatsby-and-strapi) or [Next.js](https://blog.strapi.io/strapi-next-setup/)) or Vue.js ([Nuxt.js](https://blog.strapi.io/cooking-a-deliveroo-clone-with-nuxt-vue-js-graphql-strapi-and-stripe-setup-part-1-7/)).
- Read the [concepts](../concepts/concepts.html) and [articles](../articles/) to deep dive into Strapi.
- Get help on [StackOverflow](https://stackoverflow.com/questions/tagged/strapi).
- Read the [source code](https://github.com/strapi/strapi), [contribute](https://github.com/strapi/strapi/blob/master/CONTRIBUTING.md) or [give a star](https://github.com/strapi/strapi) on GitHub.
- Follow us on [Twitter](https://twitter.com/strapijs) to get the latest news.
- [Join the vibrant and active Strapi community](https://slack.strapi.io) on Slack.
:::
- Learn how to use Strapi with React ([Gatsby](https://blog.strapi.io/building-a-static-website-using-gatsby-and-strapi) or [Next.js](https://blog.strapi.io/strapi-next-setup/)) or Vue.js ([Nuxt.js](https://blog.strapi.io/cooking-a-deliveroo-clone-with-nuxt-vue-js-graphql-strapi-and-stripe-setup-part-1-7/)).
- Read the [concepts](../concepts/concepts.html) and [articles](../articles/) to deep dive into Strapi.
- Get help on [StackOverflow](https://stackoverflow.com/questions/tagged/strapi).
- Read the [source code](https://github.com/strapi/strapi), [contribute](https://github.com/strapi/strapi/blob/master/CONTRIBUTING.md) or [give a star](https://github.com/strapi/strapi) on GitHub.
- Follow us on [Twitter](https://twitter.com/strapijs) to get the latest news.
- [Join the vibrant and active Strapi community](https://slack.strapi.io) on Slack.
:::

10
docs/3.0.0-beta.x/getting-started/quick-start.md
View File

@ -26,7 +26,7 @@ strapi new my-project --quickstart
Navigate to [**http://localhost:1337/admin**](http://localhost:1337/admin).
- Complete the form to create an Administrator user.
- Complete the form to create the first Administrator user.
- Click **Ready to start**.
## 4. Create a new Content Type
@ -53,12 +53,12 @@ Navigate back to [**PLUGINS** - **Content Type Builder**](http://localhost:1337/
- Click the **"+ Add Content Type"** button.
- Enter `category`.
- Click **"+ Add New Field"**
- A window opens with fields options:
- Click the **String** field.
- Type `category` under the **BASE SETTINGS** tab, in the **Name** field.
- Check `Required field` and `Unique field` under the **ADVANCED SETTINGS** tab.
- Click **Continue**.
- Click **"+ Add New Field"**
- In the field options window:
- Click the **Relation Field** field.
- On the right side, click the **Permissions** dropdown and select, `Restaurant`.
- In the center, select the icon the represents `many-to-many`. The text should read, `Categories has and belongs to Many Restaurants`.
@ -76,7 +76,7 @@ You will see your restaurant listed in the entries.
## 7. Add categories to the "Category" Content Type
Navigate to [**CONTENT TYPES** - **Restaurants**](http://localhost:1337/admin/plugins/content-manager/category?source=content-manager).
Navigate to [**CONTENT TYPES** - **Categories**](http://localhost:1337/admin/plugins/content-manager/category?source=content-manager).
- Click on **+ Add New Category** button. Type `Convenient` in the **Category** field. Select `Strapi Restaurant`, on the right, from **Restaurant (0)**
- Click **Save**.
@ -104,7 +104,7 @@ Navigate to [**PLUGINS** - **Roles & Permissions**](http://localhost:1337/admin/
- Repeat and scroll down under **Permissions**, find **Category**. Click the checkbox next to **find** and **findone**.
- Click **Save**.
## 9. Consume the Content Type API
## 9. Consume the Content Type's API
Here we are! The list of **restaurants** is accessible at [`http://localhost:1337/restaurants`](http://localhost:1337/restaurants).