Installation
Step-by-step guide to install and set up CodeBaseHub
Prerequisites
- Node.js (v20 or higher) - Download
- Git - Download
- pnpm - Download
- VSCode (recommended, or any other code editor)
Installation Steps
1. Clone the Repository
git clone https://github.com/CodeBaseHubTeam/codebasehub-starter-kit.git
cd codebasehub-starter-kit2. Install Dependencies
pnpm install3. Set Up Environment Variables
Follow the Supabase setup guide to get your database credentials, then add them to apps/server/.env:
DATABASE_URL=
DIRECT_URL=4. Set Up the Database
Run these commands in order:
First, push your database schema to Supabase:
pnpm db:pushThen, generate TypeScript types from your database:
pnpm db:generateConfigure GitHub Repository
Remove Previous Remote
git remote remove originAdd Your Repository
git remote add origin https://github.com/yourrepo.gitAdd Upstream Remote (for Updates)
Note: Only users with "all-in" package purchase can receive updates.
git remote add upstream https://github.com/CodeBaseHubTeam/codebasehub-starter-kit.gitVerify Remotes
git remote -vExpected output:
origin https://github.com/yourrepo.git (fetch)
origin https://github.com/yourrepo.git (push)
upstream https://github.com/CodeBaseHubTeam/codebasehub-starter-kit.git (fetch)
upstream https://github.com/CodeBaseHubTeam/codebasehub-starter-kit.git (push)Push to Your Repository
git push -u origin mainGet Updates
git pull upstream main --rebaseRun the Development Server
pnpm devOpen http://localhost:3001 in your browser.
Available Scripts
| Command | Description |
|---|---|
pnpm dev | Start development server |
pnpm build | Build for production |
pnpm start | Start production server |
pnpm lint | Run linter |
pnpm format | Format code |
pnpm type-check | Check TypeScript types |
pnpm db:push | Push schema to database |
pnpm db:generate | Generate database types |
Next Steps
- Explore the Features
- Check the Deployment Guide
Was this page helpful?