An Exclusive Accommodation Sharing Service for Students in Galway

Details
Project Title	UniLodge
Module	Applied Project & Minor Dissertation
Course	BSc (Hons) in Software Development
Video	Demo Video
Heroku	UniLodge
Authors	Faris Nassif & Aaron Burns
Supervisors	Dr. John French & Dr. Martin Kenirons

Contents

• About
• Running Locally and Requirements
• Goals and Features
• Relevant Links

About

UniLodge is a service exclusively for students. The application is designed to bridge the gap between those looking for accommodation and those looking to advertise a room or location. The features of the application are described below and a screencast of the application is available for viewing.

Requirements

• NodeJS 6.13.6 (Or Higher)
• Python 3.7.1 (Or Higher)
• Angular 7 (8 and above may cause issues)

Note: You will Not be able to run the application locally if you do not generate a Mongo URI and place it within the backend directory in a file called mongo_uri.txt.

See the Mongo Driver Guide for an overview on how to generate a Mongo URI.

Running the Program

1. If you do Not have a Mongo URI or , see the Requirements section.
2. In your command line terminal: git clone https://github.com/farisNassif/UniLodge
3. Open two terminals, one for the Angular Client and one for the Flask Server
4. In your first terminal, navigate to the /backend folder and type pip install -r requirements.txt
5. Run the Flask Server python runner.py
6. In your second terminal, navigate to the /client folder and type npm install
7. Run the Client npm start
8. The application may be accessed at http://localhost:4200/

Alternatively, the application may be accessed via Heroku

Unit Tests

• ng test

End-to-End Tests

• ng e2e

Goals and Features

For the team members initially, the end goal for the project was to create a platform for students in the Galway area to both advertise and search for accommodative services.

Initial Goals

At a minimum, the application would allow:

1. Student Login & Registration
2. Creation of Listings including full CRUD functionality
3. Communication with other users via messages or alternative means
4. Searching for listings based on specific parameters

Main Implemented Features

• Secure Registration (With a Galway college email address)
• JWT Authenticated Routing / Login
• Creation of Listings with full CRUD functionality implemented
• User comments on Listings (With authentication)
• Searching for Listings based on price / location
• User profiles
• Encrypted user data
• Cloud hosted

Project Deisgn

Final Architectural Design

Relevant Links

• Deployed Web-App
• Dissertation
• Screencast
• Swagger API