Skip to content

jaredgoldman/jazz-in-toronto

Repository files navigation

Sure, here’s an enhanced version of your README:

Jazz In Toronto

Introduction

Welcome to the Jazz In Toronto project! This full-stack web application is dedicated to showcasing the vibrant jazz scene in Toronto. Whether you're a jazz enthusiast, an artist, or a venue owner, our platform allows you to explore, add, and manage jazz events happening around the city.

Features

Admin Dashboard

  • Event Management:
    • Add, edit, and delete events.
    • View events in filterable tables for easy management.
    • Automatically generate event posts with canvas.js.

Public-Facing Site

  • Calendar:

    • Interactive calendar to view upcoming events.
  • Event Map:

    • Visualize events on a map for easy location tracking.
  • Event List:

    • Browse through a list of all events with detailed information.
  • User Submissions:

    • Users can enter new events, venues, and artists, contributing to the community-driven database.

Additional Features

  • Search Functionality:

    • Advanced search options to find events, artists, and venues.
  • Responsive Design:

    • Optimized for all devices, ensuring a seamless experience on desktops, tablets, and smartphones.

Dependencies

This project leverages several modern technologies and libraries to deliver a robust and scalable application:

  • Create T3 App:

    • A comprehensive stack featuring Next.js, Prisma, React, TypeScript, and TailwindCSS for rapid development and deployment.
  • React-Hook-Form:

    • A performant, flexible, and extensible form handling library for implementing and validating forms.
  • Radix UI:

    • An accessible and unstyled component library to build a consistent design system.

Getting Started

To get started with the project, follow these steps:

  1. Clone the repository:

    git clone https://github.com/yourusername/jazz-in-toronto.git
    cd jazz-in-toronto
  2. Install dependencies:

    pnpm install
  3. Set up the environment variables:

    • Create a .env file in the root directory.
    • Add the necessary environment variables (refer to src/env.mjs for guidance).
  4. Run the development server:

    pnpm run dev
  5. Open your browser:

    • Navigate to http://localhost:3000 to see the application in action.

This project is licensed under the MIT License. See the LICENSE file for more details.

About

T3 App for Jazz In Toronto

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published