Hueco

Description

Hueco allows users to book last minute appointments at discounted price to fill in businesses' empty time slots.

If you are a business owner you can optimize your empty time slots and make money out of it.

If you are a user, you can enjoy discounted prices from your favorite local businesses

User Stories

• 404: As an anon/user I can see a 404 page if I try to reach a page that does not exist so that I know it's my fault

• Signup: As an anon business owner I can sign up using my personal info and business picture in the platform so that I can start showing my empty time slots

• Login: As a business owner I can login to the platform so that I add or edit my available time slots

• Logout: As a business owner I can logout from the platform so no one else can use it

• Add Available Time Slots As a business owner I can add an available time

• Delete Time Slots As a business owner I can delete my time slots

• Select Available Businesses As a user I can select businesses near me that offer appointments for the day

• Book an appointment As a user I can book an appointment to the selected business

• Prepay the appointment As a user I can prepay the appointment I have selected

• Download appointment confirmation As a user I can download my QR code that I will present to my selected business

Backlog

User profile:

• Add fake payment processor
• Add search bar for businesses/discounts
• Download QR code

Client / Frontend

React Router Routes (React App)

Path	Component	Permissions	Behavior
/	HomePage	public	Home page displaying Navbar, SearchBar, Map, BusinessListCard components
/signup	SignupPage	business owners anon only	Signup form, link to login, navigate to dashboard after signup
/login	LoginPage	business owners anon only	Login form, link to signup, navigate to dashboard after login
/logout	n/a	known business owners only	Navigate to homepage after logout, expire session
/myhuecos	MyHuecoPage	known business owners only	Shows all the huecos for the current business
/myhuecos/add-hueco	AddHuecoPage	known business owners only	Add hueco
/business-details/:id	BusinessDetailsPage	Public	Business description, select available timeslot
/business-details/:businessid/contact-information/book	ContactInfoPage	Public	Add contact info to proceed the booking
/business-details/:id/payment	PaymentPage	Public	Payment of the booking
/business-details/:id/confirmation	QRCodePage	Public	Download your QR code

Components

• HomePage

• Navbar

• SearchBar

• Map

• BusinessListCard

• Signup

• Login

• MyHuecoPage

• AddHuecoPage

• EditHuecoPage

• MyProfile

• BusinessDetailsPage

• ContactInfoPage

• PaymentPage

• QRCodePage

Services

• Auth Service

  • auth.login(business owner)
  • auth.signup(business owner)
  • auth.logout()
  • auth.me()

• Business Service

  • business.getAll()
  • business.getOneById(id)
  • business.addhueco(id)
  • business.removeOneById(id)
  • business.updateOne(id)

• Booking Service

  • booking.create()

Server / Backend

Models

Business model

{
    category: {type: String},
    email: {type: String, unique: true},
    password: {type: String},
    business_name:{type: String},
    address:{type: String},
    city:{type: String},
    zip_code:{type: String},
    service:{type: String},
    phone_number:{type: String},
    discount:{type: String},
    availability:[{type: Schema.Types.ObjectId,ref:'Slot'}],
    user_booking:[{type: Schema.Types.ObjectId,ref:'Booking'}],
    initial_price:{type: String},
    discounted_price:{type: String},
    image_url: {type: String},
    description:{type: String},
    coordinates:[{type: Number }] 
  },
  {
    timestamps: {
      createdAt: 'created_at',
      updatedAt: 'updated_at'
    },
}

Booking model

{
    business_id: [{type: Schema.Types.ObjectId,ref:'Business'}],
    first_name: {type: String},
    last_name: {type: String},
    date :{type:Date, default: new (Date)},
    email: {type: String},
    timeslot_id:{type: Schema.Types.ObjectId,ref:'Slot'},
    cardholder_name:{type:String},
    card_number:{type:String},
    expiration_date:{type:String},
    cv_code:{type:String}
  },
  {
    timestamps: {
      createdAt: 'created_at',
      updatedAt: 'updated_at'
    },
}

Slot model

{
    business_id: {type: Schema.Types.ObjectId,ref:'Business'},
    date: {type: Date, default:new Date()},
    timeSlot: {type:String},
    isBooked:{type:Boolean, default:false}
   
   
  },
  {
    timestamps: {
      createdAt: 'created_at',
      updatedAt: 'updated_at'
    },
}

API Endpoints (backend routes)

HTTP Method	URL	Request Body	Success status	Error Status	Description
GET	/auth/myhueco	Saved session	200	404	Check if user is logged in and return profile page
POST	/auth/signup	{...}	201	404	Checks if fields not empty (422) and user not exists (409), then create user with encrypted password, and store user in session
POST	/auth/login	{email,password}	200	401	Checks if fields not empty (422), if user exists (404), and if password matches (404), then stores user in session
POST	/auth/logout	(empty)	204	400	Logs out the user
GET	/businesses			400	Gets all the businesses
GET	/businesses/:id	{id}	200	404	Get the information of a specific business
POST	/businesses/:id/add-hueco	{}	201	400	Create and save a new hueco
DELETE	/businesses/:id/delete/:myhuecoId	{id}	201	400	delete hueco
POST	/booking/contact-info	{business}	201	400	Create and save a new user
POST	/booking/payment-information		201	400	Create new payment information
GET	/booking/:bookingid/Qrcode	{}	201	400	show QR to download

Links

Trello/Kanban

[Link to your trello board](https://trello.com/b/YMsNqbPt/hueco or picture of your physical board

Git

The url to your repository and to your deployed project

Client repository Link

Server repository Link

Deployed App Link

Slides

The url to your presentation slides

Slides Link