Skip to content

Latest commit

 

History

History
113 lines (76 loc) · 3.53 KB

README.md

File metadata and controls

113 lines (76 loc) · 3.53 KB

iNeedHelp

The iNeedHelp project provides its users with a Q&A platform that helps them answer their questions in a complete, clean, and easy to read way. Its users are able to find multiple questions and answers along with a variety of everyday and specific topics.

Home Page HomePage
Login Page LoginPage
Question Page QuestionPage
Create Question Page CreateQuestionPage

Installing the Software Dependencies

Link to the release with the final version of the source code in the group's Git repository: https://github.com/FabioMiguel2000/iNeedHelp

To prepare you computer for development you need to install some software, namely PHP and the PHP package manager Composer.

We recommend using an Ubuntu distribution that ships PHP 8.0 (e.g Ubuntu 21.10). You may install the required software with:

sudo apt install git composer php8.0 php8.0-mbstring php8.0-xml php8.0-pgsql

The following links provide instructions for installing Docker and Docker Compose

Local Setup

  1. Clone the repository
git clone https://github.com/FabioMiguel2000/iNeedHelp.git
  1. Head inside the project directory, and install the composer dependencies:
cd iNeedHelp/
composer install
  1. Change the filename of .env_local to .env (this will overwrite the current .env file)
  2. There is a docker-compose file that sets up PostgresSQL and PgAdmin4, run:
docker-compose up -d
  1. Populate the database with seed, run:
php artisan db:seed
  1. And finally, run the web server locally with:
php artisan serve

Usage

Administration Credentials

Username Password
admin admin

User Credentials

Type Username Password
basic account inspectora 123123
basic account sanchovies 123123
Moderator JDean72 jd72olaola

Application Help

User assistence is provided in various ways such as:

  • Automaticaly redirecting to login page when performing an action that needs authentication as a visitor
  • Notifications when creating comments or answers

Figure 1.1 - App Help 1

  • Labels and hints on textboxs, which help users fill them

Figure 1.2 - App Help 2

  • Video Presentation

iNeedHelp-VideoPresentation

Team Members