Permalink
Cannot retrieve contributors at this time
Name already in use
A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
SmartBarberApp/README.md
Go to fileThis commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
106 lines (69 sloc)
2.78 KB
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# Smart Barber App | |
## Project Summary | |
The Smart Barber App is a comprehensive web application designed to streamline the process of booking appointments at a barbershop. The application integrates a robust backend built with Django and a dynamic frontend developed using React. This project aims to enhance user experience for customers and improve operational efficiency for barbers by providing a seamless and user-friendly platform for managing appointments, services, and user information. | |
## Features | |
- User Authentication: Secure login and registration system for customers and barbers. | |
- Appointment Booking: Easy-to-use interface for booking, viewing, and managing appointments. | |
- Service Management: Barbers can manage available services and their details. | |
- User Dashboard: Personalized dashboard for customers and barbers to manage their schedules. | |
- Admin Panel: Administrative access to manage users, services, and appointments. | |
## Getting Started | |
Follow the steps below to set up and run the Smart Barber App on your local machine. | |
### Prerequisites | |
- Python 3.x | |
- Node.js | |
- npm (Node Package Manager) | |
- Virtual Environment (venv) | |
- Django | |
- React | |
### Backend Setup | |
**Clone the repository:** | |
``` | |
git clone https://github.coventry.ac.uk/mohamme60/SmartBarberApp | |
cd SmartBarberApp/backend | |
Create and activate a virtual environment: | |
Copy code | |
python -m venv venv | |
source venv/bin/activate # On Windows use `venv\Scripts\activate` | |
Install the required Python packages: | |
Copy code | |
pip install -r requirements.txt | |
Apply migrations: | |
Copy code | |
python manage.py makemigrations | |
python manage.py migrate | |
Create a superuser for accessing the admin panel: | |
Copy code | |
python manage.py createsuperuser | |
Start the Django development server: | |
Copy code | |
python manage.py runserver | |
The backend server should now be running at http://127.0.0.1:8000. | |
Frontend Setup | |
Navigate to the frontend directory: | |
Copy code | |
cd ../frontend | |
Install the required npm packages: | |
Copy code | |
npm install | |
Start the React development server: | |
Copy code | |
npm start | |
The frontend application should now be running at http://localhost:3000. | |
Accessing the Admin Dashboard | |
Navigate to the admin panel: | |
Open your browser and go to http://127.0.0.1:8000/admin. | |
Log in using the superuser credentials you created earlier. | |
Once logged in, you will have access to manage users, services, and appointments through the Django admin interface. | |
Additional Information | |
API Endpoints: | |
The backend provides a set of RESTful API endpoints for interacting with the application. These endpoints can be accessed at http://127.0.0.1:8000/api/. | |
Frontend Routes: | |
The main routes of the frontend application include: | |
/ - Home | |
/services - Services | |
/barbers - Barbers | |
/booking - Booking | |
/dashboard - User Dashboard | |
/login - Login | |
/register - Register |