Getting Started with Platform Template
A step-by-step guide to setting up your project, configuring authentication, and deploying your first instance.
Introduction
Welcome to BAAS! This guide will walk you through everything you need to get your first project up and running in minutes.
Prerequisites
Before getting started, make sure you have the following installed:
- Node.js 18 or later
- pnpm, npm, or yarn
- A PostgreSQL database (local or hosted)
- Git
Installation
Clone the template repository and install dependencies:
git clone https://github.com/[your-org]/platform-template.git my-project
cd my-project
pnpm install
Configuration
Copy the example environment file and fill in your values:
cp .env.example .env.local
Set the required environment variables including your database URL, authentication secret, and any third-party API keys.
Running Locally
Start the development server:
pnpm dev
Your application will be available at `http://localhost:3000`.
Next Steps
Now that you have the template running locally, you can:
1. Customize the branding and design tokens
2. Add your own features and routes
3. Configure your payment provider
4. Deploy to your preferred hosting platform
For more detailed documentation, visit the [Docs](/docs) section.