Quick Start Guide

Step 1: Run the installation script and create a Strapi Cloud account​

1. Run the following command in a terminal:

   • NPM
   • Yarn

   npx create-strapi-app@latest my-strapi-project --quickstart
   

2. The terminal will invite you to create a Strapi Cloud account and start a free, 14-day trial. Ensure Login/Sign up is selected in the terminal, or use arrow keys to select it, and press Enter.

3. In the new browser tab that opens, ensure the confirmation code is the same as in the terminal and click Confirm.

4. Still in the browser tab, click Continue with GitHub. If you are not already logged in into GitHub with your current browser session, you might be redirected to a GitHub login page.

5. Once logged in, the browser will display a "Congratulations, you're all set!" message and you can safely close the browser tab and get back to the terminal.

As you will see in the terminal, your project is now building locally.

Step 2: Register the first local administrator user​

Once the installation is complete, your browser automatically opens a new tab.

By completing the form, you create your own account. Once done, you become the first administrator user of this Strapi application. Welcome aboard, commander!

You now have access to the admin panel:

Step 1: Create a "Restaurant" collection type​

Your restaurants directory will eventually include many restaurants, so we need to create a "Restaurant" collection type. Then we can describe the fields to display when adding a new restaurant entry:

1. Click on the Create your first Content type button.
   If it's not showing up, go to Content-type Builder in the main navigation.
2. Click on Create new collection type.
3. Type Restaurant for the Display name, and click Continue.
4. Click the Text field.
5. Type Name in the Name field.
6. Switch to the Advanced Settings tab, and check the Required field and the Unique field settings.
7. Click on Add another field.
8. Choose the Rich text (Blocks) field in the list.
9. Type Description under the Name field, then click Finish.
10. Finally, click Save and wait for Strapi to restart.

Once Strapi has restarted, "Restaurant" is listed under Content Manager > Collection types in the navigation. Wow, you have just created your very first content-type! It was so cool — let's create another one right now, just for pleasure.

Step 2: Create a "Category" collection type​

It would help getting a bit more organized if our restaurants directory had some categories. Let's create a "Category" collection type:

1. Go to Content-type Builder in the main navigation.
2. Click on Create new collection type.
3. Type Category for the Display name, and click Continue.
4. Click the Text field.
5. Type Name in the Name field.
6. Switch to the Advanced Settings tab, and check the Required field and the Unique field settings.
7. Click on Add another field.
8. Choose the Relation field.
9. In the center, select the icon that represents "many-to-many" . The text should read Categories has and belongs to many Restaurants.

11. Finally, click Finish, then the Save button, and wait for Strapi to restart.

Step 1: Log in to the admin panel of your new Strapi Cloud project​

Now that your Strapi Cloud project is created, let's log in into the project:

1. From your Strapi Cloud dashboard, click the my-strapi-project project.
2. Click the Visit app button.
3. In the new page that opens, complete the form to create the first administrator user of this Strapi Cloud project.

Logged in into our first Strapi Cloud project, we will now add data from there.

Step 2: Create an entry for the "Restaurant" collection type​

1. Go to Content Manager > Collection types - Restaurant in the navigation.
2. Click on Create new entry.
3. Type the name of your favorite local restaurant in the Name field. Let's say it's Biscotte Restaurant.
4. In the Description field, write a few words about it. If you're lacking some inspiration, you can use Welcome to Biscotte restaurant! Restaurant Biscotte offers a cuisine based on fresh, quality products, often local, organic when possible, and always produced by passionate producers.
5. Click Save.

The restaurant is now listed in the Collection types - Restaurant view of the Content Manager.

Step 3: Add Categories​

Let's go to Content Manager > Collection types - Category and create 2 categories:

1. Click on Create new entry.
2. Type French Food in the Name field.
3. Click Save.
4. Go back to Collection types - Category, then click again on Create new entry.
5. Type Brunch in the Name field, then click Save.

The "French Food" and "Brunch" categories are now listed in the Collection types - Category view of the Content Manager.

Now, we will add a category to a restaurant:

1. Go to Content Manager > Collection types - Restaurant in the navigation, and click on "Biscotte Restaurant".
2. In the Categories drop-down list at the bottom of the page, select "Brunch". Scroll back to the top of the page and click Save.

Step 4: Set Roles & Permissions​

We have just added a restaurant and 2 categories. We now have enough content to consume (pun intended). But first, we need to make sure that the content is publicly accessible through the API:

1. Click on Settings at the bottom of the main navigation.
2. Under Users & Permissions Plugin, choose Roles.
3. Click the Public role.
4. Scroll down under Permissions.
5. In the Permissions tab, find Restaurant and click on it.
6. Click the checkboxes next to find and findOne.
7. Repeat with Category: click the checkboxes next to find and findOne.
8. Finally, click Save.

Step 5: Publish the content​

By default, any content you create is saved as a draft. Let's publish our categories and restaurant.

First, navigate to Content Manager > Collection types - Category. From there:

1. Click the "Brunch" entry.
2. On the next screen, click Publish.
3. In the Confirmation window, click Yes, publish.

Then, go back to the Categories list and repeat for the "French Food" category.

Finally, to publish your favorite restaurant, go to Content Manager > Collection types - Restaurant, click the "Biscotte Restaurant" entry, and Publish it.

Step 6: Use the API​

OK dear gourmet, we have just finished creating our content and making it accessible through the API. You can give yourself a pat on the back — but you have yet to see the final result of your hard work.

There you are: the list of restaurants should be accessible by visting the /api/restaurants path of your Strapi Cloud project URL (e.g., https://beautiful-first-strapi-project.strapiapp.com/api/restaurants).

Try it now! The result should be similar to the example response below 👇.

{
  "data": [
    {
      "id": 1,
      "attributes": {
        "name": "Biscotte Restaurant",
        "description": "Welcome to Biscotte restaurant! Restaurant Biscotte offers a cuisine based on fresh, quality products, often local, organic when possible, and always produced by passionate producers.",
        "createdAt": "2021-11-18T13:34:53.885Z",
        "updatedAt": "2021-11-18T13:59:05.035Z",
        "publishedAt": "2021-11-18T13:59:05.033Z"
      }
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "pageSize": 25,
      "pageCount": 1,
      "total": 1
    }
  }
}