We’re a marketplace and booking platform that safely and easily connects clients with beauty pros offering services in private or traditional venues. Private venues include your home, a stylist space or a salon suite. Traditional venues include multi-chair salons, spas & barbershops. Your Pro, Your Venue, Your Choice!
- All users who wishes they Landing on Home page of SalonEverywhere Application.
- All Users who want to complete covid-19 testwith SalonEverywhere Application.
Before we get started Remember to take ☕ 🍕 and 💃 When You Are coding, come on Dude it all about relax
- All Neccessary libraries.
- Express JS.
- NodeJs.
- Version API using URL versioning starting with the letter “v”. A simple ordinal number would be appropriate and avoid dot notation such as 2.0. So, that why you have to add api/v2 for each route of endpoints you want to access for example: https://saloneverywhere-backend.herokuapp.com/api/path
NO | VERBS | ENDPOINTS | STATUS | ACCESS | DESCRIPTION |
---|---|---|---|---|---|
1 | POST | /api/save-user | 201 OK | public | save a user email to receive test link |
2 | POST | /api/test-covid-questions/:email | 201 OK | public | submit a user test result in database |
Other tools and technologies used in development of this application are;
- Hoster: Heroku.
- Compiler: Babel.
- Style Guide: Airbnb.
- Framework: ExpressJS.
- Documentation: Swagger.
- Linting Library: ESLint.
- API Testing environment: Postman.
- Programming language: JavaScript(ES6).
- Text Editor: VSCode, Sublime Text.
- Clone the github repository here.
- Clone this project on your machine , by running this command on in your command line or Terminal:
git clone https://github.com/key-joshua/SalonEverywhere-backend.git
- move to the cloned repository by running this command:
cd SalonEverywhere-backend
- Install the required dependencies found in package.json by running this command:
npm install
- And then to start running this project on your machine , run this command:
npm run server
- heroku : SalonEverywhere.