Skip to main content

​
Quickstart Guide

This guide will get you from zero to a running Campus instance with your first login in just a few minutes.

​
Prerequisites

Before you begin, ensure you have:
1

Clone the Repository

Clone the Campus repository and navigate into the project directory:
git clone https://github.com/mgpcampos/campus.git
cd campus
2

Install Dependencies

Use Bun to install all project dependencies:
bun install
This will install all frontend dependencies including Svelte, SvelteKit, Tailwind CSS, and other required packages.
3

Setup PocketBase

Download the PocketBase executable for your operating system and place it in the project root directory.Run the migrations to set up your database schema:
./pocketbase migrate
Then start the PocketBase server:
./pocketbase serve
PocketBase will automatically apply all migrations from the pb_migrations folder, creating the necessary database structure.
The PocketBase admin UI will be available at http://localhost:8090/_/
4

Start the Development Server

Open a new terminal window (keep PocketBase running) and start the frontend development server:
bun run dev
The application will be available at http://localhost:5173
5

Create Your First Account

Open your browser and navigate to http://localhost:5173You can now:
  • Create a new user account
  • Set up your profile
  • Start exploring Campus features
Both the frontend (port 5173) and backend (port 8090) must be running simultaneously for the application to work correctly.

​
What’s Next?

Now that you have Campus running, you can:

Explore Features

Try creating posts, joining groups, and adding events to your calendar

Customize Your Profile

Set up your academic profile with your education and research interests

Create Spaces

Organize communities by creating Spaces and Groups

Share Resources

Upload and share educational materials with your community

​
Troubleshooting

If port 5173 or 8090 is already in use, you can:
  • Stop any other processes using these ports
  • Configure PocketBase to use a different port with ./pocketbase serve --http=0.0.0.0:8091
  • Configure Vite to use a different port in vite.config.ts
Ensure you’ve:
  • Downloaded the correct PocketBase executable for your OS
  • Made the executable file runnable: chmod +x pocketbase (Linux/Mac)
  • Are running the command from the project root directory
Make sure you have the latest version of Bun installed:
bun --version
Update Bun if needed: bun upgrade
For detailed installation instructions and configuration options, see the Installation Guide.

Build docs developers (and LLMs) love

Get started for freeTalk to us