Welcome to Shaker's Kit!

Prerequisites

The project is created and tested with the following tools versions:

• Node.js@20.18.1
• pnpm@8.15.9

The moonrepo CLI that comes with the project will make sure that the correct versions of the tools are installed as you run your first task.

Install Dependencies

To install the necessary dependencies open your terminal and run the following command from the monorepo root directory:

pnpm i

Create a New Project

To create a new project from one of the templates, use the following task:

moon automations:generate-app

Follow the prompts to select the template, name, directory for your project, and other options.

After successful project creation, you'll see instructions for common operations:

To learn more about available CLI commands, please refer to the CLI Reference section.

Configure Environment Variables

While your first run of the app you might see errors like this:

❌ Invalid environment variables: { PRIVATE_MONGODB_URI: [ 'Required' ] }

This is because you haven't set up your environment variables yet. Follow the instructions in the Environment Variables section to set them up.

After setting up your environment variables, you can run the app again and it should be ready to be built and deployed.

Build a Project

To build the project, run the following task:

moon [app-name]:build

This will check the project for TypeScript, ESLint, and compilation errors.

If there are no errors, it will build the project and you will be able to preview the production version running the following task:

moon [app-name]:start

Deploy the Project

Projects created with Shaker's Kit are compatible with most of the popular deployment platforms.

We deploy our projects via self-hosted solutions like Coolify or managed solutions like Vercel.

To read more about the deployment process, please refer to the Deployment Options section.

Congratulations 🎉

At this point, you can start adding your business logic to the project and making 💰💰💰!