strapi-supercharged-template

KO | EN

gitlite — search

#hacktoberfest #llm #go #golang #machine-learning #rust #linux #docker #nodejs #macos #java #windows #mcp #openai

strapi-supercharged-template

(★ 13)

Opinionated Strapi template with enhanced typing, linters & releases process

strapi-supercharged-template Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]

<br />
<p align="center">
  <a href="https://github.com/digisquad-io/strapi-supercharged-template">
    <img src="./.github/images/strapi-supercharged.png" alt="Strapi Supercharged" />
  </a>

<h3 align="center">Strapi Supercharged</h3>

<p align="center">
    Opinionated strapi configuration with enhanced typing, linters & releases process
    <br />
    <a href="https://github.com/digisquad-io/strapi-supercharged-template"><strong>Explore the docs »</strong></a>
    <br />
    <br />
    <a href="https://github.com/digisquad-io/strapi-supercharged-template">View Demo</a>
    ·
    <a href="https://github.com/digisquad-io/strapi-supercharged-template/issues">Report Bug</a>
    ·
    <a href="https://github.com/digisquad-io/strapi-supercharged-template/issues">Request Feature</a>
  </p>
</p>

<details open="open">
  <summary><h2>Table of Contents</h2></summary>
  <ol>
    <li>
      <a href="#about-the-project">About The Project</a>
      <ul>
        <li><a href="#javascript-as-typescript-code">“Javscript as Typescript” code</a></li>
        <li><a href="#-goals">Goals</a></li>
      </ul>
    </li>
    <li>
      <a href="#getting-started">Getting Started</a>
      <ul>
        <li><a href="#prerequisites">Prerequisites</a></li>
        <li><a href="#installation">Installation</a></li>
      </ul>
    </li>
    <li>
      <a href="#usage">Usage</a>
      <ul>
        <li><a href="#-declare-your-models">Declare your Models</a></li>
        <li><a href="#-register-api-typing">Register API typing</a></li>
        <li><a href="#-register-plugins-typing">Register Plugins typing</a></li>
        <li><a href="#-use-your-supercharged-strapi">Use your Supercharged Strapi</a></li>
        <li><a href="#-packagejson-scrips">`package.json` scrips</a></li>
        <li><a href="#-docker-utils">docker utils</a></li>
      </ul>
    </li>
    <li><a href="#-roadmap">Roadmap</a></li>
    <li><a href="#%EF%B8%8F-contributing">Contributing</a></li>
    <li><a href="#license">License</a></li>
    <li><a href="#contact">Contact</a></li>
    <li><a href="#acknowledgements">Acknowledgements</a></li>
  </ol>
</details>

## About The Project

### “Javascript as Typescript” code

Use all power of Typescript directly into your Javascript

[![VSCode auto-completion preview][preview-api-content]](https://raw.githubusercontent.com/digisquad-io/strapi-supercharged-template/main/api/article/controllers/article.js 'VSCode auto-completion preview')

> **VSCode auto-completion preview**

[![Advanced linter configuration][preview-improved-linters]](https://raw.githubusercontent.com/digisquad-io/strapi-supercharged-template/main/scripts/empty-script.js 'Advanced linter configuration')

> **Advanced linter configuration**

[![Default services & controllers typing][preview-default-controllers-override]](https://raw.githubusercontent.com/digisquad-io/strapi-supercharged-template/main/api/article/controllers.d.ts 'Default services & controllers typing')

> **Default services & controllers typing**

### 🎯 Goals

- Cover **API**, **Plugins** and all **Internal Strapi** typing
- **Ahead-Of-Time** compilation errors with **Typescript**
- Highly **extensible** definitions
- **Linters** with all recommendation enabled _(eslint+prettier)_
- **React** linters for admin customization
- Follows **standard** [conventional-commits](https://www.conventionalcommits.org) and releases process

## Getting Started

To get a local copy up and running follow these simple steps.

### Prerequisites

> @todo

### Installation

1. Clone the repo
   ```sh
   git clone https://github.com/digisquad-io/strapi-supercharged-template.git
   ```
   > 🚀 **[Or use this repository as template](https://github.com/digisquad-io/strapi-supercharged-template/generate)**
2. Install NPM packages
   ```sh
   npm install # yarn
   ```
3. Run the tests
   ```sh
   npm test # yarn test
   ```

## Usage

### 💡 Declare your Models

> @todo

_For complete examples, please refer to the [Article API model typing](api/article/models/article.d.ts) or the [Product model typing from sample plugin](plugins/sample/models/product.d.ts)_

### 💡 Register API typing

> @todo

_For a complete example, please refer to the [ArticleAPI typing](api/article/index.d.ts)_

### 💡 Register Plugins typing

> @todo

_For a complete example, please refer to the [SamplePlugin typing](plugins/sample/index.d.ts)_

### 🌠 Use your Supercharged Strapi

#### In controllers

> @todo

_For a complete example, please refer to the [Article controller](api/article/controllers/article.js)_

#### In services

> @todo

_For a complete example, please refer to the [Article service](api/article/services/article.js)_

#### In middlewares

> @todo

_For a complete example, please refer to the [Sample middleware (from sample plugin)](plugins/sample/middlewares/sample.js)_

#### In scripts

> @todo

_For a complete example, please refer to the [`scripts/initData.js` demo script](scripts/initData.js)_

### 💲 `package.json` scrips

<table>
  <thead>
    <tr>
      <th>command</th>
      <th>description</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td colspan="2" align="center"><em>Linters</em></td>
    </tr>
    <tr>
      <td><code>yarn lint</code></td>
      <td>Run all linter in sequence</td>
    </tr>
    <tr>
      <td><code>yarn lint:eslint</code></td>
      <td>Try to fix eslint errors</td>
    </tr>
    <tr>
      <td><code>yarn lint:prettier</code></td>
      <td>Try to fix prettier errors</td>
    </tr>
    <tr>
      <td colspan="2" align="center"><em>Tests</em></td>
    </tr>
    <tr>
      <td><code>yarn test</code></td>
      <td>Run all tests in parallel</td>
    </tr>
    <tr>
      <td><code>yarn test:tsc</code></td>
      <td>Run Typescript compiler (only output errors)</td>
    </tr>
    <tr>
      <td><code>yarn test:eslint</code></td>
      <td>Run eslint in check mode</td>
    </tr>
    <tr>
      <td><code>yarn test:prettier</code></td>
      <td>Run prettier in check mode</td>
    </tr>
    <tr>
      <td colspan="2" align="center"><em>Git & Releases utils</em></td>
    </tr>
    <tr>
      <td><code>yarn commit</code></td>
      <td>Git commit with prompt</td>
    </tr>
    <tr>
      <td><code>yarn release</code></td>
      <td>Run release creation if test pass</td>
    </tr>
    <tr>
      <td><code>yarn release:standard-version</code></td>
      <td>Create release from git commit history</td>
    </tr>
    <tr>
      <td colspan="2" align="center"><em>Others</em></td>
    </tr>
    <tr>
      <td><code>./scripts/empty-script.js</code></td>
      <td>Demo script</td>
    </tr>
  </tbody>
</table>

### 📦 docker utils

> @todo

_For a complete example, please refer to the [`Dockerfile`](Dockerfile) and [`.docker` folder](.docker/)_

## 📅 Roadmap

See the [roadmap project board](https://github.com/digisquad-io/strapi-supercharged-template/projects/1) for a list of proposed features (and known issues).
Feel free to open a [new discussion](https://github.com/digisquad-io/strapi-supercharged-template/discussions), this project aims to be collaborative!

## 🙋‍♂️ Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/amazing-feature`)
3. Commit your Changes (`git commit -m 'feat(amazing-feature): add something amazing'`)
4. Push to the Branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request

> :octocat: **tip**: try to use <kbd>.</kbd> keyboard shortcut on this repository _(or <kbd>shift</kbd>+<kbd>;</kbd>)_

## License

Distributed under the MIT License. See `LICENSE.md` for more information.

## Contact

digisquad.io - contact@digisquad.io

## Acknowledgements

- [Strapi](https://github.com/strapi/strapi)

[contributors-shield]: https://img.shields.io/github/contributors/digisquad-io/strapi-supercharged-template.svg?style=for-the-badge
[contributors-url]: https://github.com/digisquad-io/strapi-supercharged-template/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/digisquad-io/strapi-supercharged-template.svg?style=for-the-badge
[forks-url]: https://github.com/digisquad-io/strapi-supercharged-template/network/members
[stars-shield]: https://img.shields.io/github/stars/digisquad-io/strapi-supercharged-template.svg?style=for-the-badge
[stars-url]: https://github.com/digisquad-io/strapi-supercharged-template/stargazers
[issues-shield]: https://img.shields.io/github/issues/digisquad-io/strapi-supercharged-template.svg?style=for-the-badge
[issues-url]: https://github.com/digisquad-io/strapi-supercharged-template/issues
[license-shield]: https://img.shields.io/github/license/digisquad-io/strapi-supercharged-template.svg?style=for-the-badge
[license-url]: https://github.com/digisquad-io/strapi-supercharged-template/blob/master/LICENSE.txt
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/company/digisquad-io
[preview-api-content]: ./.github/images/preview-api-content.png
[preview-improved-linters]: ./.github/images/preview-improved-linters.png
[preview-default-controllers-override]: ./.github/images/preview-default-controllers-override.png

strapi-supercharged-template

strapi-supercharged-template Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

strapi-supercharged-template

strapi-supercharged-template Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README