https://github.com/starkblaze01/hostel-management

Hostel-Management
https://github.com/starkblaze01/hostel-management

express hacktoberfest hostel-management-system hostel-room-allotment jest jwt-authentication mern-stack mongo node react redux-thunk

Last synced: 3 months ago
JSON representation

Hostel-Management

• Host: GitHub
• URL: https://github.com/starkblaze01/hostel-management
• Owner: starkblaze01
• Created: 2019-08-09T04:51:52.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-06T15:53:45.000Z (about 2 years ago)
• Last Synced: 2024-08-21T16:46:20.809Z (5 months ago)
• Topics: express, hacktoberfest, hostel-management-system, hostel-room-allotment, jest, jwt-authentication, mern-stack, mongo, node, react, redux-thunk
• Language: JavaScript
• Homepage: https://hostel-management01.herokuapp.com/
• Size: 3.34 MB
• Stars: 75
• Watchers: 5
• Forks: 46
• Open Issues: 26
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.com/starkblaze01/Hostel-Management.svg?branch=master)](https://travis-ci.com/starkblaze01/Hostel-Management)

# 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](https://github.com/starkblaze01/Hostel-Management/tree/master/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](https://github.com/starkblaze01/Hostel-Management/blob/master/API_Endpoints.md).**

### Screenshots

![Home Page](https://github.com/starkblaze01/Hostel-Management/blob/Docs/home.png)

![Dashboard](https://github.com/starkblaze01/Hostel-Management/blob/Docs/dashboard.png)

![Room Cleaning](https://github.com/starkblaze01/Hostel-Management/blob/Docs/room%20cleaning.png)

## 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](https://mlab.com/). 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](iiitvadodara.ac.in) 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](https://github.com/starkblaze01/Hostel-Management/tree/master/client/src/components/pages) according to your need.

## Team Members

- [Aman Yadav](https://github.com/amany9000)

- [Avdhesh Yadav](https://github.com/avi-spc)

- [Anshuman Verma](https://github.com/anshumanv)

- ,and [Me](https://github.com/starkblaze01/) 😎

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

## Found an Issue or any suggestions

Make an issue [here](https://github.com/starkblaze01/Hostel-Management/issues/new).