2019-03-07 14:16:22 +01:00
# Quick Start Guide
2017-10-10 11:15:24 +02:00
2019-03-13 18:31:02 +01:00
Get ready to make Strapi up and running in **less than 5 minutes** 🚀
2019-02-06 19:16:54 +01:00
2019-03-13 18:31:02 +01:00
< div class = "video-container" >
< 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 >
2019-02-06 19:16:54 +01:00
2019-06-19 18:54:23 +02:00
_For a step-by-step guide, please take a look at the [detailed tutorial ](quick-start-tutorial.html )._
2019-02-04 19:45:00 +01:00
2019-03-07 14:16:22 +01:00
## 1. Install Strapi globally
2017-10-10 11:15:24 +02:00
2019-03-13 18:31:02 +01:00
Please make sure [Node.js and npm are properly installed ](install-requirements.html ) on your machine.
2017-10-10 11:15:24 +02:00
2017-10-12 16:33:09 +02:00
```bash
2019-03-07 14:16:22 +01:00
npm install strapi@alpha -g
2017-10-12 16:33:09 +02:00
```
2017-10-12 11:00:15 +02:00
2019-03-07 14:16:22 +01:00
## 2. Create a new project
2017-10-10 11:15:24 +02:00
2019-03-07 14:16:22 +01:00
```bash
strapi new cms --quickstart
```
2019-02-11 14:27:07 +01:00
2019-03-07 14:16:22 +01:00
## 3. Create an admin user
2019-02-11 14:27:07 +01:00
2019-03-13 18:31:02 +01:00
Navigate to [**http://localhost:1337/admin** ](http://localhost:1337/admin ).
2019-02-11 14:27:07 +01:00
2019-06-19 18:54:23 +02:00
- Fill in the form.
- Click **Ready to start** .
2019-02-11 14:27:07 +01:00
2019-03-07 14:16:22 +01:00
## 4. Create a Content Type
2019-02-11 14:27:07 +01:00
2019-03-13 18:31:02 +01:00
Navigate to [**PLUGINS** - **Content Type Builder** ](http://localhost:1337/admin/plugins/content-type-builder ).
2019-02-11 14:27:07 +01:00
2019-06-19 18:54:23 +02:00
- 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.
2019-02-11 14:27:07 +01:00
2019-03-07 14:16:22 +01:00
## 5. Manage and add data to Content Type
2019-02-11 14:27:07 +01:00
2019-03-13 18:31:02 +01:00
Navigate to [**CONTENT TYPES** - **Restaurants** ](http://localhost:1337/admin/plugins/content-manager/restaurant?source=content-manager ).
2019-02-07 21:36:01 +01:00
2019-06-19 18:54:23 +02:00
- 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** .
2019-02-11 14:27:07 +01:00
2019-06-19 18:54:23 +02:00
You will see your restaurant listed in the entries.
2019-02-11 14:27:07 +01:00
2019-03-07 14:16:22 +01:00
## 6. Set roles and permissions
2019-02-11 14:27:07 +01:00
2019-03-13 18:31:02 +01:00
Navigate to [**PLUGINS** - **Roles & Permission** ](http://localhost:1337/admin/plugins/users-permissions/roles ).
2019-02-11 14:27:07 +01:00
2019-06-19 18:54:23 +02:00
- 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** .
2019-02-07 21:36:01 +01:00
2019-06-19 18:54:23 +02:00
## 7. Consume the Content Type's API
2019-02-07 21:36:01 +01:00
2019-03-13 18:31:02 +01:00
Here we are! The list of **restaurants** is accessible at [`http://localhost:1337/restaurants` ](http://localhost:1337/restaurants ).
2019-02-11 14:27:07 +01:00
::: tip CONGRATULATIONS
2019-03-13 18:31:02 +01:00
👏 Congratulations, you have now completed the Strapi Quick Start. Where to go next?
2019-06-19 18:54:23 +02:00
- 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.
:::