Barber Finder is a web-based platform designed to connect customers with barbers and salons. Customers can discover services, book appointments at a salon or request a home visit. Barbers and salon managers can manage appointments and communicate with customers through the platform.
- Customer accounts: Register, sign in and manage bookings.
- Salon and barber discovery: Browse salons, barbers and available services.
- Appointment booking: Select a service, barber, date and time.
- Home visits: Request a barber to travel to a customer's address, subject to availability and travel-distance rules.
- Appointment management: Managers review and confirm bookings; customers and barbers can view appointment details and status.
- Notifications: SMTP email notifications inform barbers about confirmed appointments.
- Customer--barber messaging: In-app conversations let customers and barbers discuss appointments without exchanging personal phone numbers.
- Reviews and feedback: Customers can provide feedback after appointments.
- Backend: Node.js and Express.js
- Frontend: Pug templates, JavaScript and CSS
- Database: MySQL
- Real-time messaging: Socket.IO, where integrated
- Email: SMTP
- Maps and routing: Google Maps Geocoding API and Routes API
- Development: Docker and npm The exact services and integrations available depend on the current project configuration.
- A customer creates an account or signs in.
- The customer browses salons, barbers and services.
- The customer chooses a salon appointment or requests a home visit.
- For a home visit, the address and journey are checked against the salon's home-visit settings.
- The customer selects an available date and time and reviews the booking.
- The booking is submitted for manager review.
- The manager confirms or rejects the booking.
- When confirmed, the barber receives an email notification and the customer is notified.
- The customer and barber can communicate through the platform.
- After the appointment, the customer can leave a review.
Home visits allow participating barbers to serve customers at their addresses. Google Maps services can be used to verify addresses and calculate road journeys. Travel availability and pricing depend on the configured salon settings.
The Google Maps server API key must be stored securely as an environment variable and must not be exposed in browser-side code.
The publishing copy has its own Docker Compose project,
barber-platform-publishing. Its read-only schema mount uses
./database/schema.sql in this repository, and its database volume is
barber-platform-publishing_barber_mysql_data.
To start this copy's database, run docker compose up -d --wait mysql from
the repository folder. MySQL uses host port 3308 (DB_PORT=3308 for an app
connecting from Windows); phpMyAdmin uses http://localhost:8081 when started
with docker compose up -d phpmyadmin. This keeps the primary working copy's
database on port 3306 separate. Use the database credentials configured in
this copy's docker-compose.yml in your local .env.
- Install Node.js and npm.
- Clone or open the project repository.
- Install dependencies: npm install
- Create a local .env file using the environment variables required by the project. Check the existing configuration and setup documentation for the exact names and values.
- Configure the MySQL database and apply the project's database schema or migrations.
- Start the development server using the script configured in package.json, for example: npm run dev
- Open the local address printed by the development server. Do not commit .env files, passwords, database credentials or API keys to source control. Configuration Notes The project may require configuration for:
- MySQL connection details
- SMTP credentials
- Google Maps server API key
- Application time zone
- Payment provider credentials, if online payments are enabled Use test credentials and payment-provider test mode during development. Configure production secrets through the hosting provider's environment-variable settings.
The following features have been discussed for future development and should only be described as available once implemented and tested:
- Configurable Barber Finder booking fee.
- Automated booking-fee refunds when appointments are cancelled.
- ChatGuard moderation to detect contact sharing and attempts to arrange bookings outside the platform.
- Admin tools for reviewing moderation incidents, payments and refunds. Security
- Keep secrets and API keys out of source control.
- Enforce authentication and role-based authorization on the server.
- Validate user input on the server.
- Verify payment status and payment webhooks on the server if payments are enabled.
- Restrict access to appointment and chat data to authorized users.
- Do not expose customers' private contact details unnecessarily. Project Status Barber Finder is under active development. Features and integrations may change as the booking, home-visit, messaging and administration workflows are completed and tested.