Stator
Stator, your go-to template for the perfect stack. 😍🙏
Install / Use
/learn @chocolat-chaud-io/StatorREADME
🚀 Quick Start
The interactive CLI will guide you to easily setup your project.
npm run get-started
📋 Table of Contents
</br>📚 About the Project
Have you ever started a new project by yourself?<br/> If so, you probably know that it is tedious to set up all the necessary tools.<br/> Just like you, the part I enjoy the most is coding, not boilerplate.
Say hi to stator, a full-stack TypeScript template that enforces conventions, handles releases, automates deployments and much more!
If you want more details about how this idea was implemented, I recommend reading the series of blog articles I wrote on the topic.
</br>🦄 Demo Application
This template includes a demo todo application that serves as an example of sound patterns. Of course, you won't be creating a todo application for your project, but you can use this as an example of useful patterns and learn how to use the technologies presented in this project.
Technical Stack
For a detailed list of all those technologies, you can read this blog article.
| Deployment | Database | Backend | Frontend | Testing | Conventions | | -------------------------------------------------------------------------------- | ------------------------------------------------ | ------------------------------------------------------------- | ------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | | DigitalOcean App Platform | Postgres | Nest | React | jest | commitlint | | semantic-release | Mongo | Fastify | React Router | cypress | eslint | | docker-compose | TypeORM | Swagger | Redux | | prettier | | | NestJs CRUD | ReDoc | Redux Toolkit | | | | | | | Material UI | | |
</br>💥 Getting Started
Prerequisites
- Docker Compose
- node.js v14.x
Copy the template
This repository is a repository template, which means you can use the Use this template button at the top to create your project based on this.
*Note: If you have an existing repository, this will require more work. I would recommend using the use template button and migrating your current code to the newly created projects.
Make it yours
You will now want to make this project yours by replacing all organization and project naming occurrences with your own names. Thankfully, we have a script just for that:
npm run rename-project -- --organization {YOUR_ORGANIZATION_NAME} --project {YOUR_PROJECT_NAME}
*Note: I highly recommend that the project name is the same as your git repository.
On completion, you will see the following message:
Run the application
First, install the dependencies:
npm i
Then, run the whole stack:
npm run postgres
npm start api
npm start webapp
Finally, why not test it:
npm test api && npm run e2e webapp-e2e
For a full list of available commands, consult the package.json.
Continuous Integration
This templates integrates Github Actions for its Continuous Integration. The existing workflows are under .github/workflows.
Currently, the CI will ensure all your apps work properly, by building and testing.
For your pull requests, it will create a review application which will basically host your whole stack on a VM.
Once everything is ready a new comment will be added to your pull request with the deployment URL.
When the PR is closed, your review app will be destroyed as it's purpose will have been served.
It's sacrifice will be for the greater good and also your wallet.
To have the CI working, you must:
- (Optional) If you want review apps to work, you should follow the instruction provided by the
get-startedCLI. - (Optional) Link your repository with Codecov by inserting your
CODECOV_TOKENin github secrets. - (Optional) Insert your Nx Cloud access token in github secrets under
NX_CLOUD_TOKEN. This enables for caching and faster build times.
Deployment
The application can be deployed in two different ways, depending on your objectives.
Digital Ocean App Platform
For a simple and fast deployment, the new App Platform from Digital
Related Skills
bluebubbles
351.4kUse when you need to send or manage iMessages via BlueBubbles (recommended iMessage integration). Calls go through the generic message tool with channel="bluebubbles".
node-connect
351.4kDiagnose OpenClaw node connection and pairing failures for Android, iOS, and macOS companion apps
slack
351.4kUse when you need to control Slack from OpenClaw via the slack tool, including reacting to messages or pinning/unpinning items in Slack channels or DMs.
frontend-design
110.7kCreate distinctive, production-grade frontend interfaces with high design quality. Use this skill when the user asks to build web components, pages, or applications. Generates creative, polished code that avoids generic AI aesthetics.
