Skip to content

UoaWDCC/hidtreas

Repository files navigation

Hidden Treasures

Hidden Treasures is a website designed to support and promote charity events. The platform includes a blog page where users can post about charity-related events and an event page showcasing upcoming future events. The website also includes a CMS (Payload CMS) to allow admins to manage events and blog posts.

Project Leads

  • Chris Kang - Project Manager
  • Atul Kodla - Technical Lead

Developers

  • Jack Harken
  • Andrew Chen
  • Toshiro Mendoza
  • Ruby McNamee - Developer/Designer
  • [Developer Name Here]
  • [Developer Name Here]
  • [Developer Name Here]
  • Nathan Dalpatan - Developer
  • Daniel Kim

Designer

  • Bryanna

Tech Stack

  • Frontend: Next.js with TypeScript
  • Backend: Payload CMS
  • Database: MongoDB

Features

  • Blog Management: Admins can create, read, update, and delete blog posts about charity events.
  • Event Management: Admins can create, update, and remove events to keep the website updated with upcoming charity events.
  • Secure Authentication: Admins can log in with secure authentication mechanisms.

Installation

Prerequisites

Before setting up the project, ensure that you have the following installed:

  • Node.js (v14 or higher)
  • MongoDB (or MongoDB Atlas account for cloud database)

Steps to Run the Project Locally

  1. Clone the repository:

    git clone https://github.com/UoaWDCC/hidtreas.git
  2. Navigate to project directory:

    cd hidtreas
  3. Install project dependencies using pnpm:

    pnpm install
  4. Set up the environment file:

    Request a copy of the environment files from the project leads and add them to the root folder of the directory.

  5. Run the development server:

    Start the dev server with this command:

    pnpm run dev

    Visit http://localhost:3000 to view the website running locally.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published