LiteSpace

Project Strucutre

• packages/*
  • packages/assets - sharable assets (files and images).
  • packages/atlas - API SDK.
  • packages/auth - Server authentication and authorization module.
  • packages/email - Email templates.
  • packages/headless - React components logic that can be used in the web and mobile.
  • packages/luna - Components library.
  • packages/models - Database models.
  • packages/sol- Sharable pure javascript logic that can be use on web, server, and mobile.
• apps/*
  • apps/blog - LiteSpace blog.
  • apps/dashboard - LiteSpace admin dashboard.
  • apps/mobile - LiteSpace mobile app.
  • apps/nebula - LiteSpace landing page.
  • apps/nova - LiteSpace main web platform.

Project Setup

Tools

nvm

1. Install NVM (node version manager)

   curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.35.3/install.sh | bash

2. Configure NVM

   export NVM_DIR="$HOME/.nvm"
   [ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"  # This loads nvm
   [ -s "$NVM_DIR/bash_completion" ] && \. "$NVM_DIR/bash_completion"  # This loads nvm bash_completion

3. Verify NVM installation by running nvm -v. You should see no errors.

4. Install the current project node version.

   # from the project root
   nvm install

5. Use the project node version.

   nvm use

pnpm

Enable pnpm

corepack enable pnpm

Run the server

1. Run docker compose

   # from services/server/
   sudo docker compose up -d

   note: if you want to remove the containers and flush the data use sudo docker compose down

2. Setup your environment variables

   # from services/server
   cp .env.example .env

   Make changes if needed.

3. Setup database

   1. Setup environment variables to be able to apply the database migrations.

          # from packages/models/
          cp .env.example .env

   2. Apply the migrations by running pnpm migrate up from packages/models/

   3. To undo the migrations run pnpm migrate down

Verify pnpm installation by running pnpm -v. You should see no errors.

Docker

Follow the instractions on how to install Docker on Ubuntu (recommended but feel free to use any linux distro)