install.md

id
install

Install

Prerequisites

• NodeJS (18.x).

Install Manifest

Run the following on your terminal from the root of your project:

npx add-manifest@latest

This will create a manifest/backend.yml file and add the required dependencies.

Then, serve the backend locally:

npm run manifest

You can now:
- See your Admin panel at http://localhost:1111 using the email [email protected] and the password admin
- Use your REST API at http://localhost:1111/api

:::tip

If you already have a frontend app, you can run the npx add-manifest command from your project root to include it in your repo.

:::

Note with PNMP

As PNPM blocks postinstall scripts, we have to adapt the þackage.json. Add this to your package.json file before doing pnpm install:

  "pnpm": {
    "onlyBuiltDependencies": [
      "@nestjs/core",
      "sharp",
      "sqlite3"
    ]
  }