Skip to content

Latest commit

 

History

History
250 lines (184 loc) · 9.53 KB

README.md

File metadata and controls

250 lines (184 loc) · 9.53 KB


Logo

HairBnB

A web app connecting customers with independent hairstylists
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. License
  6. Contact

About The Project

Product Name Screen Shot

First day of school coming up? Picture Day? It can be hard to find independent hair stylists who you can trust to work with your hair. With HairBnB, independent hair stylists can showcase their work, prices, and areas of expertise. Clients can look over reviews and clearly display their hair types, allowing a match in needs and services. This platform not only allows users to look at photos of hairstylist's work, but also allows them to chat with them before booking to make sure there is a sense of trust. If you're interested in finding a centralized place for all your hair needs, check us out!

Built With

  • React
  • GitHub Fork
  • GitHub Fork
  • CSS
  • GitHub Fork
  • Express.js
  • Node.js
  • MongoDB

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

Start by creating an empty directory mern mkdir mern && cd mern

Next, create a folder for the back end and name it server. Then, we will initialize the package.json file using npm init.

  • mkdir server && cd server* npm init -y

In order to use ECMAScript Modules, the officially supported standard format to package JavaScript code for reuse, we’ll add a line to the package.json file.

  • "type": "module",* We will also install the dependencies. npm install mongodb express cors

Installation

  1. Get a free API Key at https://example.com
  2. Clone the repo 
    git clone https://github.com/mderege/hairbnb.git
  3. Install NPM packages 
    npm install
  4. Enter your API in config.js 
    const API_KEY = 'ENTER YOUR API';
  5. Change git remote url to avoid accidental pushes to base project 
    git remote set-url origin github_username/repo_name
git remote -v # confirm the changes

(back to top)

Usage

Use this app to create profiles and book appointments with local independent hairstylists!

  • As a client, tailor your bio with details on your hair type, the hairstyle you’re looking for, your location, and pictures of your hair
  • As a hairstylist, build out your brand by adding the hair types you work with, hairstyles you provide, reviews of past gigs, pictures of past work, and costs for your services!
  • Book/cancel appointments using our calendar integration!

For more examples, please refer to the Documentation

(back to top)

Roadmap

  • Signup and login functionality
    • Choose between stylist and customer profiles
  • Customizable, browsable, searchable profiles
  • Book appointments with our calendar integration

See the open issues for a full list of proposed features (and known issues).

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Mahlet Derege - [email protected] Sean Onamade - [email protected] Brian Shon - [email protected] Stephanie Ting - [email protected]

Project Link: https://github.com/mderege/hairbnb

(back to top)

(back to top)

)