Prerequisites
Before you begin, make sure you have the following tools installed:- Node.js (version 18 or higher)
- Bun (recommended for faster installation and development)
- PostgreSQL (version 14 or higher)
- Git
Clone the Repository
Start by cloning the ProStack repository to your local machine or using it as a template for your new project.Install Dependencies
ProStack uses Bun for dependency management and as a JavaScript runtime. While npm is supported, we recommend using Bun for the best performance:Set Up Environment Variables
ProStack requires several environment variables to function correctly. We provide example configuration files to help you get started:- Copy the example environment file:
- Open the
.envfile in your code editor and update the values as needed:
Database Setup
ProStack uses PostgreSQL as its database. Follow these steps to set up your database:-
Install PostgreSQL if you haven’t already:
- macOS:
brew install postgresql@16 && brew services start postgresql@16 - Ubuntu:
sudo apt install postgresql-16 - Windows: Download installer from postgresql.org
- macOS:
- Create a PostgreSQL database:
-
Update the
DATABASE_URLin your.envfile with your PostgreSQL credentials. - Run the database migrations to create the necessary tables:
Start the Development Server
Once you’ve completed the setup, you can start the development server:Next Steps
Now that you have ProStack up and running, here are some next steps to consider:Environment Setup
Learn about advanced configuration options
Local Development
Development workflow and best practices
Authentication
Understand the authentication system
Database Management
Learn how to work with the database
