Skip to content

12458/gthousing

Repository files navigation

GT Housing Availability Dashboard

Overview

The GT Housing Availability Dashboard is an open-source project aimed at providing Georgia Tech students with a real-time, user-friendly interface to check the availability of on-campus housing.

A hosted version is available at gthousing.shangen.org.

Features

  • Real-time housing availability data
  • User-friendly dashboard interface
  • Filter by housing type and location
  • Responsive design

Getting Started

Installation

# Clone the repository
git clone https://github.com/12458/gthousing.git

# Navigate into the project directory
cd gthousing

# Install dependencies
npm install

# Start the development server
npm run dev

Usage

  1. Open the dashboard at http://localhost:3000 in your web browser.
  2. Select your preferred housing type and location.
  3. View real-time availability and subscribe to notifications.

Contributing

We welcome contributions from the community! To contribute:

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature/YourFeature)
  3. Make your changes and commit them (git commit -m 'Add new feature')
  4. Push to the branch (git push origin feature/YourFeature)
  5. Create a pull request.

License

Licensed under the MIT License

Contributors

Acknowledgements

Thanks to the Georgia Tech Housing Department for providing access to housing availability data.

About

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •