/GenConCal

Application to assist with choosing events for GenCon gaming convention.

Primary LanguageRustMIT LicenseMIT

GenCon Calendar

vercel deployment shield

Introduction

The Gencon Calendar Application is a web application built with Next.js framework that aims to assist users in choosing events for their GenCon gaming convention event registration. The applications provides features to browse and filter events based on a number of paramaters including conflicting times.

This documentation will guide you through the installation process, explain the paplications features and functionalities, and provide an overview of the code structure for further development or customization.

Table of Contents

  1. Installation
    • Prerequisites
    • Installation Steps

1. Installation

Prerequisites

Before installing the GenCon Calendar App, ensure you have the following installed on your machine:

  • Node.js (version 14 or higher)
  • npm or yarn package manager

Installation Steps

  1. Clone the repository.
  2. Navigate to the project directory and then the /frontend folder.
  3. Install the project dependencies by running:
npm install
// or
yarn install
// or
pnpm install
  1. Once the installation is complete, start the development server:
npm run dev
// or
yarn dev
// or 
pnpm dev
  1. Open your web browser and navigate to http://localhost:3000 to access the GenCon Calendar App.