Virtual Makerspace

🚀 Project Overview

Virtual Makerspace is a collaborative platform designed to facilitate remote making and creativity. This README provides step-by-step instructions to set up and run the project locally.

📋 Prerequisites

• Node.js v20.10.0
• pnpm
• Docker (for database)

🛠 Development Setup

1. Node.js Version Management

Ensure you're using the correct Node.js version:

nvm use

2. Install Dependencies

Install all project dependencies:

# From project root
pnpm install:all

🗃 Backend Setup

1. Start Database Services

Launch PostgreSQL and Adminer using Docker:

# From project root
docker-compose up -d

2. Initialize Prisma

Generate and apply database migrations:

# From backend directory
pnpm generate
pnpm migrate

3. Start Apollo Server

Run the backend server:

# From project root
pnpm backend  # Runs Apollo Sandbox at port 5000

Alternatively, open Prisma Studio:

# From backend directory
pnpm studio

4. Initialize Database Data

Populate the database with default user and schedule data:

# From backend directory
pnpm initData

🖥 Frontend Setup

1. Update GraphQL Code Generator

# From frontend directory
pnpm codegen

2. Start React Application

# From project root
pnpm frontend  # Runs React app at port 5173

🛠 Troubleshooting

Killing Stuck Ports

To release a port (replace 8080 with your specific port):

sudo kill -9 $(sudo lsof -t -i:8080)

📚 Additional Resources

• Apollo Sandbox Documentation
• Prisma ORM Documentation
• React Documentation
• Vite Documentation
• Tailwind CSS Documentation

🤝 Contributors