strapi-template

🚀 Getting started with Strapi

Strapi Template Docker README

install and execute

Install the latest version of the strapi-template package locally.

npx create-strapi-app@latest strapi-template --template strapi-template --no-run

When prompted to Choose your installation type, select Quickstart (recommended).

run docker containers

Run the strapi app and associated MySQL database via Docker. The database will automatically connect to (or create) the persistent Docker volume named 'strapi-data'.

Navigate to the root directory and run:

npm run unpack-compose

This will unpack the needed files for docker-compose, build the Docker images, and run the Strapi and MySQL containers via your local Docker.

prepare for npm publish

A specific file structure is needed to push changes to the public npm package strapi-template (see https://docs.strapi.io/dev-docs/templates). To autonomously restructure the repo and acheive the needed file structure, run the following:

npm run gen-template

publish to npm registry

If changes were made to the package and a new package is needed to be published then a new (unique) version will be required in the NPM registry.

• navigate to package.json
• delete the field "private: true"
• modify the version field according to the changes (major, minor, patch)
• save the file
• publish to npm registry using npm publish

Note: You may be required to login via npm adduser in order to publish to the registry.

Strapi Standard README

Strapi comes with a full featured Command Line Interface (CLI) which lets you scaffold and manage your project in seconds.

develop

Start your Strapi application with autoReload enabled. Learn more

npm run develop
# or
yarn develop

start

Start your Strapi application with autoReload disabled. Learn more

npm run start
# or
yarn start

build

Build your admin panel. Learn more

npm run build
# or
yarn build

⚙️ Deployment

Strapi gives you many possible deployment options for your project including Strapi Cloud. Browse the deployment section of the documentation to find the best solution for your use case.

📚 Learn more

• Resource center - Strapi resource center.
• Strapi documentation - Official Strapi documentation.
• Strapi tutorials - List of tutorials made by the core team and the community.
• Strapi blog - Official Strapi blog containing articles made by the Strapi team and the community.
• Changelog - Find out about the Strapi product updates, new features and general improvements.

Feel free to check out the Strapi GitHub repository. Your feedback and contributions are welcome!

✨ Community

• Discord - Come chat with the Strapi community including the core team.
• Forum - Place to discuss, ask questions and find answers, show your Strapi project and get feedback or just talk with other Community members.
• Awesome Strapi - A curated list of awesome things related to Strapi.

_{🤫 Psst! Strapi is hiring.}