Skip to content

Saikmat/CKMS

Repository files navigation

UMBC Interactive Map

Welcome to the UMBC Interactive Map! This application is designed to provide students, staff, and visitors with an interactive map of the University of Maryland, Baltimore County (UMBC) campus. It offers comprehensive information on UMBC buildings, frequently visited rooms, and up-to-date directions, making campus navigation clearer and more accessible. With its powerful search function and accurate, real-time directions, this tool significantly enhances campus navigation, reducing confusion and improving the overall user experience for anyone navigating the UMBC campus.


Features

  • Building Details: Click on a building to view available offices, facilities, and resources
  • Search & Navigation: Find offices based on specific services or assistance needed, with clear directions to their locations.
  • Campus Resources: Highlight key areas such as academic buildings, dining halls, and campus services such as Retriever Essentials.
  • Accurate & Reliable Information: Locations are correctly marked, relevant, and easy to access. Real-time map with GPS integration.

Tech Stack

This project uses the following technologies:

  • Frontend:
  • Backend:
    • Node.js the server-side runtime environment for handling backend logic
    • Express.js handles routing and API requests
    • MariaDB stores the list of places in the map and their associated data
  • Other Tools:

Getting Started

Prerequisites

Make sure you have the following software installed:

Installation

  1. Clone the repository:

    git clone https://github.com/yourusername/umbc-interactive-map.git
    cd umbc-interactive-map
  2. Install the required dependencies:

    npm install
  3. Run the website locally:

Either use: bash npm start

This will launch the map website at http://localhost:3000.

Or use: bash vite

Vite is being actively supported, and is much lighter weight. This will launch the map website at http://localhost:5173.

How to Contribute

We welcome contributions to improve the UMBC Interactive Map. Here's how you can help:

  1. Fork the repository and create a new branch:

    git checkout -b feature/your-feature-name

    To connect your branch to an issue, use this

    git checkout -b CKMS-<issue number>-dev
  2. Make changes and commit them:

    git commit -m "Add your feature"
  3. Push to your fork:

    git push origin feature/your-feature-name
4. **Create a pull request**.

---
## Features to Implement

- Merge backend and frontend
- Migrate database from CSV file to relational database
- Implement search capability
- Improve UI
- Implement favorite and recent search capabilities
- Error handling for GPS functionality
- Solicit stakeholder feedback


---
## Additional Information
Here is information about us and how you can use our code outside the repository.

### Contact

For questions or suggestions, please reach out to the product owner at [RX93572@umbc.edu].

### License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors