Skip to content

Latest commit

 

History

History
81 lines (55 loc) · 2.3 KB

README.md

File metadata and controls

81 lines (55 loc) · 2.3 KB

Accordee Frontend

This React frontend is part of my first proper web devleopment project. Most of the code as well as this readme was AI generated, and thus not very good. I will be working on a refactored version for my next project and sharing this one for archival purposes. If I have time later I will update this to remove the cloud infrastructure related functions such as the google bucket connection to make it easier to run locally.

For now the main demo site should be viewable at https://accord.ee .

--

Accordee is a dynamic web application for creating and managing personalized dashboards. Built with React, leveraging React Three Fiber for 3D effects, and recently migrated to Vite for an optimized developer experience and faster build times.

Features

  • Dynamic Dashboard Creation: Users can create customizable dashboards.
  • Interactive 3D Elements: Utilizing React Three Fiber for engaging UI components.
  • Live Dashboard Editing: Real-time editing capabilities for dashboard customization.
  • Responsive Design: Ensures a seamless experience across various devices and screen sizes.

Technology Stack

  • Frontend: React, React Three Fiber
  • Build Tool: Vite
  • Backend: Express.js (Accordee Backend)
  • Database: Postgresql
  • Containerization: Docker with Nginx for serving production builds

Getting Started

Prerequisites

  • Node.js (v16 or later)
  • NPM
  • Docker (for containerization and deployment)

Local Development

  1. Clone the repository:

    git clone https://dev.eriksmedia.com/erreib/accordee-frontend
  2. Install dependencies:

    cd accordee-frontend
    npm install
  3. Run the development server:

    npm run dev

Building for Production

  • Run the build script to create a production-ready build:
    npm run build

Docker

  • Build and run the Docker container:
    docker build -t accordee:latest .
    docker run -p 80:80 accordee:latest

Configuration

  • Environment variables:
    • VITE_BACKEND_URL: URL to the backend API.
    • VITE_GCP_BUCKET_URL: URL to the Google Cloud Platform bucket for media storage.

Contributing

[Instructions for contributing, if applicable]

License

[License information, if applicable]

Accordee Frontend © 2023 Accordee Team