/nuxt-strapi-demo

A demo using of Strapi and TwicPics to optimize images in a Nuxt 3 application

Primary LanguageVue

Nuxt 3 + Strapi + TwicPics Demo

This demo is built with:

When running locally, we use ngrok to make Strapi accessible online for TwicPics.

Setup

Install the dependencies:

# Using yarn
yarn

# Or using npm
npm install

Local Development

Strapi CMS

Create a Strapi project using:

npx create-strapi-app@latest strapi-backoffice --quickstart

Launch your Strapi CMS instance by running:

npm run develop

Then go through the following steps:

1. Create the Article collection type

Navigate to the Content-Type Builder to create a new collection type with the following properties:

  • Display name: Article
  • API ID (Singular): article
  • API ID (Plural): articles

Then, select your Article collection type and add it the following fields:

  • Title — Text type
  • Cover — Media type
  • Excerpt — Text type

3. Add some articles

Navigate to the Content Manager and select your newly created Article collection.

Add a few articles (at least 4 to have relevant results) by clicking Create new entry and filling the data.

Note
You can use Unsplash images to find images. We recommend downloading them in Large format to have enough quality to play with the image optimization features.

Nuxt app

Copy the .env.example file as .env and update the environment variables as needed.

Note
If you didn't change it, the default host for Strapi is http://localhost:1337

Start the development server

npm run dev

TwicPics

To optimize the medias coming from Strapi, we will Create a TwicPics path.

Login to your TwicPics account:

  • Select/create a workspace, e.g. My Company
  • Select/create a domain, e.g. https://my-company.twic.pics
  • Create a path mapping to your source, e.g. local-strapi to https://very-long-key.eu.ngrok.io (Read paragraph below)

Get your Strapi URL

To make your Strapi app available online, we will use ngrok to open a tunnel.

For an app running on http://localhost:1337, run

ngrok http 1337

Ngrok will prompt an output that contains a line that looks like the following

Forwarding                    https://0aca-2a01-e0a-20b-ff40-6830-a17b-ecf7-47e3.eu.ngrok.io -> http://localhost:1337

This is the forwarding address you need to use as source in your TwicPics path.

Warning
This is only for local development. In production, use your real Strapi app hostname.

Production

Build the application for production:

npm run build