Hotseat

Manage customers and services of your barber shop

Click here to see the database model

📌 Table of Contents

• Features
• Installation
• Getting Started
• FAQ
• Found a bug? Missing a specific feature?
• Contributing
• License

🚀 Features

• 💈  Appointment and schedule management
• 👦🏼  Create providers and customers
• 🔐  Authentication flow with password reset
• 🗄  Update files with the Amazon S3 API
• 📨  Send emails with Amazon SES

👷 Installation

You need to install Node.js and Yarn first, then in order to clone the project via HTTPS, run this command:

git clone https://github.com/LauraBeatris/hotseat-api.git

SSH URLs provide access to a Git repository via SSH, a secure protocol. If you use a SSH key registered in your Github account, clone the project using this command:

git clone [email protected]:LauraBeatris/hotseat-api.git

Install dependencies

yarn install

Or

npm install

Create your environment variables based on the examples of .env.example

cp .env.example .env

After copying the examples, make sure to fill the variables with new values.

Setup a database

You must install Docker in your machine, fill the environment values related to database configurations and then run the following commands in order to create Postgres, Mongo and Redis containers.

docker-compose up

🏃 Getting Started

Run the transactions in order to configure the database schema

yarn typeorm migration:run

Run the following command in order to start the application in a development environment:

yarn dev

📮 Faq

Question: What are the technologies used in this project?

Answer: The technologies used in this project are NodeJS + Express Framework to handle the server and TypeORM as the Object Relational Mapper

🐛 Issues

Feel free to file a new issue with a respective title and description on the the Hotseat API repository. If you already found a solution to your problem, I would love to review your pull request! Have a look at our contribution guidelines to find out about the coding standards.

🎉 Contributing

Check out the contributing page to see the best places to file issues, start discussions and begin contributing.

📕 License

Released in 2020. This project is under the MIT license.

Made with love by Laura Beatris 💜🚀