QuickAssist is a web application designed to connect users with service providers offering a variety of services such as house cleaning, market shopping, babysitting, cooking, and laundry. This project serves as a portfolio piece for Muritadhor Arowolo, a Software Engineering student at ALX Africa, and was submitted as part of the graduation requirements for the specialization phase of the ALX Software Engineering program.
QuickAssist provides a platform where users can register as either service providers or consumers. Service providers can offer various services, and consumers can easily find and book these services. The application is structured with a backend built using Flask and a frontend developed with React.js.
- User Registration: Users can sign up as either a service provider or a regular user.
- Service Listing: A landing page displays all available service providers, which can be filtered by service type.
- Dashboard: Service providers have access to a dashboard to manage their services.
- Chat Feature: Users can communicate directly with service providers via an in-app chat.
- Profile Pages: Each user has a profile page where their details and services are displayed.
- API Documentation: Detailed API documentation is available for developers.
Ensure you have the following installed:
Python 3.8+
Node.js and npm
Git
- Clone the repository:
git clone https://github.com/Armolas/QuickAssist.git cd QuickAssist - Install Python dependencies:
cd backend
pip install -r requirements.txt- Install Node.js dependencies for the frontend:
cd ../frontend/app
npm install- Navigate to the backend API directory:
cd QuickAssist/backend/api - Start the backend server:
PYTHONPATH=. python app/main.py
- The backend server will start, and you can access the API documentation at:
http://localhost:5000/swagger
- Navigate to the frontend app directory:
cd QuickAssist/frontend/app - Start the frontend server:
npm run start
- The frontend application will start, and you can access it at:
http://localhost:3000
The API documentation is available at /swagger on the backend server. This provides detailed information about the available endpoints, request parameters, and response formats.
This project is licensed under the MIT License. See the LICENSE file for details.
Muritadhor Arowolo is a passionate software engineering student at ALX Africa. He is focused on developing scalable and efficient software solutions. This project, QuickAssist, was submitted as part of his portfolio for the specialization phase of the ALX Software Engineering program.
- Twitter: @armolas_06
- LinkedIn: Muritadhor Arowolo