Skip to content

Latest commit

 

History

History
154 lines (111 loc) · 5.33 KB

README.md

File metadata and controls

154 lines (111 loc) · 5.33 KB
Raw

Strapi scaffold with TypeScript, PNPM & Docker

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

Deploy to Production environment

Open in GitHub Codespaces Open in Gitpod

🎮 Stack

🔌 Pre-installed plugins

Back-end

  1. Content Type explorer
  2. Data transformer
  3. Swagger document

Front-end

  1. Color picker
  2. Multiple selector
  3. React Icons picker
  4. CKEditor 5

💡 Best practice

  1. Install Settings GitHub app in your account or organization

  2. Click the Use this template button on the top of this GitHub repository's home page, then create your own repository in the app-installed namespace above

  3. Click the Open in GitHub codespaces button on the top of ReadMe file, then an online VS Code development environment will be started immediately

  4. Recommend to add a Notification step in GitHub actions for your Team IM app

  5. Remind the PMs & users of your product to submit Feature/Enhancement requests or Bug reports with Issue forms instead of IM messages or Mobile Phone calls

  6. Collect all these issues into Project kanbans, then create Pull requests & add closes #issue_number into its description for automation

🚀 Scripts

develop

Start your Strapi application with autoReload enabled. Learn more

npm i pnpm -g
pnpm i
cp .env.example .env # change .env by yourself
pnpm develop

start

Start your Strapi application with autoReload disabled. Learn more

npm start

build

Build your admin panel. Learn more

pnpm build

pack-image

Build your Docker image locally.

pnpm pack-image

container

Run your Docker image locally.

pnpm container

⚙️ 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.