Skip to content

Latest commit

 

History

History
105 lines (71 loc) · 2.27 KB

README.md

File metadata and controls

105 lines (71 loc) · 2.27 KB

A platform for developers to plan and manage virtual workshops

Core features

  1. Users should be able to create and schedule virtual workshops

  2. Users should be able to register for workshops, receiving confirmation for registering and receiving reminders for upcoming events

  3. Interactive workshop session with video conferencing

Tech stack

Architecture Overview

The architecture of this project revolves around a streamlined development and deployment process, leveraging Docker in the development environment for consistency and mirroring production conditions. For deployment, the project utilizes Vercel and Supabase postgres database

Roadmap

  • Deploy the application to Vercel
  • Add app configuration
  • Add landing page
  • Add auth with lucia
  • Workshop creation
  • Edit workshop
  • Delete workshop
  • Participant registration
  • Join workshops with workshop code
  • Complete workshop & dashboard page
  • Interactive workshop session

Running locally

With Docker

  1. Clone the repository
git clone https://github.com/Raphico/byte.git
cd byte
  1. Copy and update .env.example to .env
cp .env.example .env
  1. Start the application
docker-compose up --build
  1. Update database schema
pnpm run db:migrate

Without Docker

  1. Clone the repository
git clone https://github.com/Raphico/byte.git
cd byte
  1. Copy and update .env.example to .env
cp .env.example .env
  1. Install dependencies
pnpm i
  1. Update database schema
pnpm run db:migrate
  1. Start the development server
pnpm run dev

License

Licensed under the MIT license. Check the LICENSE file for details.