Skip to content

owengaspard/dormDefender

Repository files navigation

Dorm Defender

Dorm Defender is a secure, mobile-friendly web application developed as part of LSU's Geaux Engineering program. The project was designed to enhance dormitory access control, allowing students to remotely unlock their dorm rooms using their LSU ID.

Features

Secure Dorm Registration: Users can register their dorm rooms by logging in with their LSU ID, ensuring that only authorized individuals can gain access.

Remote Unlocking: Provides a convenient way for students to unlock their dorms remotely, improving security and ease of access.

Responsive Design: Built with mobile-friendliness in mind using TailwindCSS, ensuring a seamless user experience across all devices.

Efficient Data Management: Utilizes MongoDB as the backend database to handle user data and dorm registrations effectively.

Tech Stack

Frontend: React, TailwindCSS

Backend: Node.js, Express.js

Database: MongoDB

Awards & Recognition

Dorm Defender won first place in the LSU Geaux Engineering competition. The project was judged on its overall objective, code cleanliness, execution, presentation and communication, and creativity.

Setup & Installation

Clone the repository:

git clone https://github.com/owengaspard/dormDefender.git

Install dependencies:

cd dorm-defender
npm install

Setup a MongoDB database

You can head over to MongoDB and setup a database to use with the project. Add the Mongo URI to the backend API backend/server.js.

Run the Express server:

cd backend
npm install
node server.js

Run the web server:

(in project root)

npm run dev

Contributing

Contributions are welcome! Feel free to open an issue or submit a pull request.

License

This project is licensed under the MIT License.

About

2024 Geaux Engineering Project

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published