Planorama

Planorama is a scheduling and booking application designed to streamline event management. It provides a user-friendly interface for creating, managing, and viewing bookings. To delete events, right-click on the scheduled event and select OK.

Link to application: [TBA]

Features

• User-friendly frontend built with modern web technologies.
• Backend powered by Node.js and MongoDB for efficient data handling.
• Real-time updates and seamless integration between frontend and backend.
• Easy setup and deployment instructions.

Prerequisites

Before you begin, ensure you have the following installed on your system:

• Node.js (v14 or higher)
• npm (v6 or higher)
• MongoDB (v4.4 or higher)

Setup Instructions for running Frontend locally

1. Open terminal and navigate to the frontend directory:

   cd frontend

2. Install the required packages:

   npm install

3. Run the application:

   npm run dev

4. Open the local URL provided in the terminal in your web browser.

Setup Instructions for running Backend locally

1. Open terminal and navigate to the backend directory:

   cd backend

2. Install the required packages:

   npm install

3. Ensure your local MongoDB instance is running (for Mac):

   brew services start mongodb-community
   brew install mongosh
   mongosh
   use scheduler

4. Start the backend server:

   node server.js

Project Structure

The project is organized into the following directories and files:

planorama-slides.pdf
README.md
backend/
    dummyEvents.json
    package.json
    server.js
    vercel.json
    weather.js
frontend/
    eslint.config.js
    index.html
    package.json
    README.md
    tsconfig.app.json
    tsconfig.json
    tsconfig.node.json
    vite.config.ts
    public/
        vite.svg
    src/
        App.js
        App.tsx
        index.css
        index.js
        main.tsx
        vite-env.d.ts
        assets/
            hunter-campus-2001415976.jpg
            react.svg
        pages/
            AssistantSidebar.tsx
            BookingForm.tsx
            Calendar.tsx

Key Files and Directories

• backend/: Contains server-side code and configurations.

  • server.js: Main backend server file.
  • dummyEvents.json: Sample data for testing.
  • weather.js: Handles weather-related functionalities.

• frontend/: Contains client-side code and configurations.

  • src/: Source code for the frontend application.
    • App.tsx: Main application component.
    • pages/: Contains individual page components like BookingForm.tsx and Calendar.tsx.
  • public/: Public assets like images and icons.

• planorama-slides.pdf: Presentation slides for the project.

• README.md: Documentation for the project.

Usage

To verify that events are being added to the local backend database:

1. Open mongosh in your terminal.
2. Switch to the scheduler database:

   use scheduler

3. View the bookings collection:

   db.bookings.find()

Note

The backend server is on PORT 4000 for Mac and code in the frontend has it set to PORT 5000. Changes need to be made to run locally for Mac.