https://github.com/garcane/fcc-salon-appointment-db
This project is part of the FreeCodeCamp Relational Database certification. The objective was to build a database that stores information about services, customers, and appointments in a salon and create a Bash script that interacts with this database to manage and schedule appointments.
https://github.com/garcane/fcc-salon-appointment-db
bash bash-script bash-scripting postgres postgresql postgresql-database sql
Last synced: 3 months ago
JSON representation
This project is part of the FreeCodeCamp Relational Database certification. The objective was to build a database that stores information about services, customers, and appointments in a salon and create a Bash script that interacts with this database to manage and schedule appointments.
- Host: GitHub
- URL: https://github.com/garcane/fcc-salon-appointment-db
- Owner: garcane
- Created: 2024-09-03T14:45:24.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-26T11:29:03.000Z (over 1 year ago)
- Last Synced: 2025-08-05T23:31:09.367Z (11 months ago)
- Topics: bash, bash-script, bash-scripting, postgres, postgresql, postgresql-database, sql
- Language: SQL
- Homepage:
- Size: 9.77 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Salon Appointment Scheduler
This project is part of the FreeCodeCamp Relational Database certification. The objective was to build a database that stores information about services, customers, and appointments in a salon and create a Bash script that interacts with this database to manage and schedule appointments.
## Project Structure
- **Database**: The database is managed using PostgreSQL.
- **Script**: A Bash script (`salon.sh`) was created to interact with the database.
### Files
- `salon.sql`: Contains SQL commands to create the database, including the necessary tables and relationships to store the services, customers, and appointments.
- `salon.sh`: A Bash script to manage and schedule appointments by interacting with the database based on user input.
## Database Schema
The database consists of the following tables:
### `services` Table
| Column Name | Data Type | Constraints |
| -------------- | --------- | ---------------- |
| `service_id` | SERIAL | PRIMARY KEY |
| `name` | VARCHAR | UNIQUE, NOT NULL |
### `customers` Table
| Column Name | Data Type | Constraints |
| -------------- | --------- | ---------------- |
| `customer_id` | SERIAL | PRIMARY KEY |
| `phone` | VARCHAR | UNIQUE, NOT NULL |
| `name` | VARCHAR | NOT NULL |
### `appointments` Table
| Column Name | Data Type | Constraints |
| -------------- | --------- | ------------------------------------- |
| `appointment_id`| SERIAL | PRIMARY KEY |
| `customer_id` | INTEGER | REFERENCES `customers(customer_id)` |
| `service_id` | INTEGER | REFERENCES `services(service_id)` |
| `time` | TIMESTAMP | NOT NULL |
## Usage
### Prerequisites
- **PostgreSQL**: Ensure PostgreSQL is installed and running on your machine. Connect to the database using:
```bash
psql --username=freecodecamp --dbname=salon
```
- **Database Setup**: The database should be created and populated using the provided `salon.sql` file.
### Running the Script
The `salon.sh` script can be run from the command line:
```bash
./salon.sh
```
- **Service Selection**: The script will display a list of available services for the user to choose from.
- **Customer Details**: The user will be prompted to enter their phone number. If the phone number is not found in the database, the user will be asked to provide their name.
- **Appointment Scheduling**: The user will then be asked to provide a preferred time for the appointment.
- **Confirmation**: The script will confirm the appointment details with the user.
### Example Usage
```bash
~~~~~ MY SALON ~~~~~
Welcome to My Salon, how can I help you?
1) Haircut
2) Manicure
3) Pedicure
# Select a service
1
# Enter phone number
555-1234
# If new customer
What's your name?
John Doe
# Enter preferred time
2:00 PM
# Confirmation
I have put you down for a Haircut at 2:00 PM, John Doe.
```
### Error Handling
- If an invalid service number is entered, the script will prompt: `That is not a valid number.`
- If no available services are found, the script will prompt: `I could not find that service. What would you like today?`
## Project Completion
### Fixing the Database
The database was set up and refined to meet the project requirements:
1. The `services` table stores available salon services.
2. The `customers` table stores customer information, including unique phone numbers.
3. The `appointments` table stores scheduled appointments, linking services and customers.
### Bash Script
The `salon.sh` script was developed to manage and schedule salon appointments by interacting with the PostgreSQL database.
## Installation
1. Clone this repository.
2. Set up the database:
- Log in to PostgreSQL:
```bash
psql --username=freecodecamp --dbname=postgres
```
- Run the SQL commands in `salon.sql` to create and populate the database:
```sql
\i salon.sql
```
3. Make sure the `salon.sh` script has execution permissions:
```bash
chmod +x salon.sh
```
4. Run the script as described above.