Manifest Documentation ๐
Introductionโ
Manifest is a lightweight Backend-as-a-Service (BaaS) that fits into a single YAML file.
Key advantages:
- โก Develop 10x faster comparing to traditional approaches
- ๐ Easy to read and version control for humans and AIs
- ๐๏ธ Self-hosted Free Open Source software
Install Manifestโ
Follow the steps below to install Manifest in your local machine.
Prerequisitesโ
- NodeJS (20.x or superior).
Installation stepsโ
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 admin@manifest.build
and the password admin
- Use your REST API at http://localhost:1111/api
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"
]
}