This guide covers everything you need to install and configure Proseperity for your project. We'll walk through prerequisites, installation steps, database setup, and initial configuration.
Prerequisites
Before installing Proseperity, make sure you have the following tools installed on your system. Node.js version 18 or later is required, along with npm or your preferred package manager. You'll also need a Neon Postgres database — you can create a free account at neon.tech.
System Requirements
Proseperity runs on macOS, Linux, and Windows. You'll need at least 512MB of available RAM for the development server, and a modern web browser for the admin interface. The Miller Columns drag-and-drop feature works best on desktop browsers.
Database Setup
Create a new Neon project and note your connection string. You'll need this during the configuration step. Proseperity uses Drizzle ORM to manage the database schema, so migrations are handled automatically.
Installation Steps
Clone the repository and install dependencies using npm install. Copy the .env.example file to .env.local and fill in your database connection string. Run the database migration with npx drizzle-kit push to create the required tables.
Running the Development Server
Start the development server with npm run dev. The application will be available at http://localhost:3000. The admin interface is at /admin and the reader is at the root URL.
Seeding Sample Data
If you want to start with sample content, run npm run seed to populate the database with example folders, articles, and headers. This is a great way to explore the application's features without creating content from scratch.
Configuration
Proseperity can be configured through environment variables and the Next.js configuration file. The most important setting is the DATABASE_URL which points to your Neon Postgres instance.
Environment Variables
DATABASE_URL is the only required environment variable. It should contain your full Neon connection string including the SSL mode parameter. Additional variables for AI features and image uploads can be configured as needed.
Next Steps
Once you have Proseperity running, head to the admin interface to start creating your first content. Check out the Tutorials section for a step-by-step guide to creating your first article.