Local Setup

This guide will walk you through the process of setting up Memogic on your local machine.

Prerequisites

• Install Git
• Install NodeJS (v20 or newer)
• Install Docker
• Install pnpm
• Install MongoDB Compass (optional, but recommended)

Initial Setup (Only Once)

1. Clone the Repository

   Navigate to the directory where you want to store the project and run:

   git clone https://github.com/Memogic/memogic
   cd memogic

2. Install Dependencies

   Run the following command to install the project dependencies:

   pnpm install

3. Set Up Environment Variables

   Most environment variables are pre-configured in the .env.example files. Copy these to new .env files. Some services may require additional environment variables. Contact @Benjamin-Frost if needed.

   Ensure you set up the following .env files:

   • /apps/api/.env
   • /apps/web/.env
   • /packages/database/.env
   info

   On macOS, port 5000 might already be in use by AirDrop services. To avoid conflicts, you may need to change the port in both /apps/api/.env and /apps/web/.env (VITE_API_URL). For example, you could use port 5002 instead.

Regular Setup (Every Time)

1. Start Docker Services

   Run the following command to start the Docker services:

   docker compose up
   info

   To use some of our Docker services, you need access to our GHCR packages. Please refer to the GitHub Docs for instructions on Authenticating to the Container registry to access these packages from your local machine.

2. Start the Application

   Run the following command to start the application:

   pnpm dev
   tip

   A Keycloak user with the credentials user:user is created by default. You can use these credentials to log in to the application.