Hostel-Checkin

DESCRIPTION OF THIS PROJECT.

Hostel-Checkin is a web app project to be carried out by IMSU DSC with the collaborative and effective work of its team functionaries for a greater output. This project will involve the expeditious work of these teams:

I. Content Developers/Writers

II. Designers

III. Front-end Developers

IV. Back-end Developers (Python, Django and Firebase)

THE CONTENT DEVELOPERS/WRITERS

These team functionaries are relied on to update the README file after cloning it to their Repositories so as to reflect the description and objective of the project, afterwards, push/create a pull request.

THE UI/UX DESIGNERS

These team functionaries are to Mock-up for a web base applications where students can create a profile, search for Hostel and book an appointment once they find a suitable one.

THE FRONT-END DEVELOPERS

Content/Project features based on User case 1: Translate the mock-up to HTML, CSS and JavaScript code/pages. No JavaScript framework is needed.

THE BACK-END DEVELOPERS

Content/Project features based on User, Hostel management and Administrator ;

Case 1: User should be able to;

• Search for hostel
• Book appointment
• Contact Hostel management
• Rate Hostel experience
• and more…

Case 2: A hostel Rep should be ale to;

• Create hostel Domain
• Update hostel details
• Delete hostel uploaded
• Make changes where needed
• Communicate with other hostel Reps

Case 3: An Admin should be able to:

• Monitor hostel Rep activities
• Approve pending hostels
• Delete/deactivate any user
• And more…

Stages towards the achievement of this project should be strictly followed. And this involves:

a) Mock-up and design template.

b) Front-end Code-base Deployment

c) Test Running of Front-end

d) Integrating of Front-end into Django framework

e) Designing the Database

f) Database Structure

g) MySQL Server Setup

h) Full implementation of design/General implementation

i) Deployment of the cloud

j) Documentation

k) Presentation

OBJECTIVES OF THIS PROJECT.

This project with maximum input will be an accomplishable one. Being chosen as one of the projects to be carried out implies that the overview of its aim is beyond imaginations. How helpful, favourable, gratifying, convenient, reposeful, and lots more it could be to the users would be immeasurable. The objectives will definitely be found among these:

a) To eradicate the stress/difficulty users could encounter during the search of a vacant, better, or convenient place at campus and its environs.

b) To provide upper limit satisfaction to users while making their choice of hostel.

c) To curb scam, theft etc in the cause of this search either from the Hostel Agents, or ungrateful individuals.

d) To upload hostel location, distance, features and probably price tags to enable users make fulfilling choices and equally pack-in at will.

e) Will be able to provide a secured activities.

f) Equally aimed at boosting the confidence of a new or returning student’s parents, knowing fully well that there child has been cleared for a convenient place to stay.

g) The aim of this project is vast…

WELCOME AND THANK YOU FOR CONTRIBUTING TO THIS PROJECT. PLEASE TAKE YOUR TIME TO STUDY THIS PAGE CAREFULLY BEFORE MAKING ANY CHANGES TO THE CODEBASE. TRY TO BE ON A PROPER PHASE WITH THE REST OF THE TEAM

Welcome, and thank you for contributing to this project. Please take your time to study this document carefully before making any changes to the codebase, to ensure you're on the same page with the rest of the team and we can all collaborate seamlessly.

Set up and Contribution

To set up this project, first fork this repositiory to your own account

Locate fork button and click on it.

Then go to your desktop and create a folder, name it hostel_checkin. Open your terminal and change your working directory to hostel_checkin you created.

$ cd hostel_checkin

Then run all the commands in the terminal. Set up your origin and upstream remotes by running the following commands

git remote add origin https://github.com/{YOUR-GITHUB-USERNAME}/hostel_checkin.git

git remote add upstream https://github.com/dscimsu/hostelCheck-in.git

Pull the code to Your project directory and set it up by running the following command

git fetch upstream
git checkout master

After contributing based on a specified issue, run the following commands after commiting changes

git pull upstream
git push origin master

Then from your master branch in your forked repository, create a pull request to the dscimsu development branch.

Thanks for contributing.