MetaSketch

---

The MetaSketch is a platform designed to bring people together in virtual, immersive environments. This project enables users to connect, interact, and explore various experiences in the metaverse through a seamless and dynamic interface.

📝 Table of Contents

• About
• Project Structure
• Getting Started
• Built Using
• Authors

🧐 About

The Workspace aims to create a seamless digital environment where users can socialize, collaborate, and experience virtual worlds. Built with a robust backend and intuitive frontend, this project is designed to support dynamic interactions, real-time communications, and multimedia sharing within the metaverse.

🏗 Project Structure

This Turborepo includes the following packages/apps:

Apps

• http: REST API server
• web: Next.js frontend application

Packages

• db: Database schema and migrations using Prisma
• eslint-config: Shared ESLint configurations
• typescript-config: Shared TypeScript configurations
• ui: Shared React component library

🏁 Getting Started

Follow these instructions to get the project up and running on your local machine for development and testing purposes.

Prerequisites

To run the project locally, make sure you have these installed:

• Node.js - v18 or higher
• Docker - For containerized environments
• Kubernetes - For managing deployments
• Cert-Manager - For SSL certificates
• ArgoCD - For GitOps and CI/CD

Installing

Clone the repository:

git clone https://github.com/akshitjain16/MetaSketch.git
cd community

Install dependencies:

pnpm install

Set up environment variables:

cp .env.example .env

Running the Application Locally

To run the application locally:

pnpm dev

To start with Docker:

docker-compose up

🔧 Running the Tests

We use Jest for testing the application. Run the following command to execute tests:

npm test

Break down into end-to-end tests

End-to-end tests cover user scenarios within the platform, like authentication and interactive functionalities.

npm run test:e2e

Code Style Tests

To maintain code quality and style, run:

npm run lint

🎈 Usage

Once deployed, users can sign up, sign in, and explore the metaverse through their personalized profiles. Interactive features include messaging, customizable avatars, and access to virtual spaces.

🚀 Deployment

To deploy the MetaSketch to a live environment, follow these steps:

1. Dockerize the Application:

   docker build -t akshitjain16/metaSketch .
   docker push akshitjain16/metaSketch

2. Deploy to Kubernetes:

   • Set up a Kubernetes cluster and configure the manifests.
   • Deploy with ArgoCD:

     kubectl apply -f deployment.yaml

3. GitOps with ArgoCD:

   • Initialize a GitOps repository.
   • Set up ArgoCD to automatically synchronize and deploy new changes.

⛏️ Built Using

• Express - Server Framework
• React - Web Framework
• Node.js - Server Environment
• Docker - Containerization
• Kubernetes - Deployment Management
• ArgoCD - GitOps

✍️ Authors

• @akshitjain16 - Project Owner & Lead Developer

See also the list of contributors who participated in this project.

🎉 Acknowledgments

• Thanks to the open-source community
• Inspired by advancements in virtual technology and online communities