Skip to main content

Quick Start

Get up and running with Bellamy Book in 5 minutes!

Step 1: Start Services​

Using Docker (recommended): From the repo root, start infrastructure and services:

cd dockerLocalENV
docker compose up -d

Then run the apps locally (see Installation):

  • Frontend: cd Src/frontend && npm run local
  • Admin: cd Src/admin && npm run local
  • Backend: Open in Rider and run with profile StartApp (or dotnet run --project Src/backend/API)

Without Docker: Start PostgreSQL, MongoDB, Redis, then the Backend API, Frontend, and Admin as in the Installation guide.

Step 2: Create Your First Account​

  1. Open the frontend application: http://localhost:3000
  2. Click "Sign Up"
  3. Fill in your details:
    • Email
    • Password
    • Full Name
    • Username

Step 3: Create Your First Post​

  1. After logging in, you'll see the feed
  2. Click on the "What's on your mind?" box
  3. Write your post content
  4. Optionally add images or videos
  5. Click "Post"

Step 4: Explore Features​

  • Add Friends: Search for users and send friend requests
  • React to Posts: Click the like button or choose other reactions
  • Comment: Leave comments on posts
  • Share: Share posts with your network
  • Create Stories: Share temporary stories

Step 5: Customize Your Profile​

  1. Click on your profile picture
  2. Go to "Edit Profile"
  3. Add a profile picture
  4. Add a cover photo
  5. Update your bio and other details

Common Tasks​

Send a Message​

  1. Click the "Messages" icon
  2. Search for a friend
  3. Start a conversation

Create a Story​

  1. Click "Create Story" at the top of your feed
  2. Upload a photo or video
  3. Add text or stickers
  4. Share with your network

Manage Notifications​

  1. Click the notifications bell
  2. View all your notifications
  3. Mark as read or clear notifications

Next Steps​