Skip to content

starkblaze01/Hostel-Management

Repository files navigation

Build Status

Hostel-Management

Manage Your Hostel

Topics Covered

  • MERN Stack
  • Hostel Management
  • Bootstrap
  • Reactstrap
  • Redux
  • JWT Authentication
  • API testing using Jest

Development and Installation

Install Backend Dependencies

  • npm install

Install Frontend Dependencies

  • npm run client-install

Setup up dev_keys for database

  • Either run local MongoServer or,
  • Setup Mongo Server at online platform like mlab and Create a keys_dev.js file in config folder and set up:-
module.exports = {
  mongoURI: YOUR_LOCAL_MONGO_SERVER_URI,
	secretOrKey: YOUR_SECRET
}; 

Run the application

  • npm run dev

For testing

  • npm run test

Find API Documentation here.

Screenshots

Home Page

Dashboard

Room Cleaning

Note

  • You can set up the database on your local server of your college and create multiple ids to access that data. The Link mentioned in the Description https://hostel-management01.herokuapp.com/ has a common database instance created on mlab. It is just to show the working of the project in the deployed state. Feel free to test it out. But make sure to delete your entries after creating and testing it. Also, don't save any personal information over this deployed link because anyone can acces it. If amount of data exceeds the our storage at mlab, then it will be deleted.
  • The application model is based on our Institute Hostel. There are four blocks A, B, C, D. And four batches(B.Tech 2016, B.Tech 2017, B.Tech 2018, and B.Tech 2019) having occupancy in hostel rooms. These thing may differ for many Institute. You can easily change the structure of these components from here according to your need.

Team Members

Liked the project? Hit the star button to show support!

Found an Issue or any suggestions

Make an issue here.