Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/laurabeatris/hotseat-api
Rest API of a barber shop application - Built with Express, TypeORM and Postgres
https://github.com/laurabeatris/hotseat-api
backend express node postgres react rest solid tsringe typeorm
Last synced: about 2 months ago
JSON representation
Rest API of a barber shop application - Built with Express, TypeORM and Postgres
- Host: GitHub
- URL: https://github.com/laurabeatris/hotseat-api
- Owner: LauraBeatris
- License: mit
- Created: 2020-04-25T01:35:29.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-07T19:22:34.000Z (almost 2 years ago)
- Last Synced: 2024-10-11T10:48:10.814Z (2 months ago)
- Topics: backend, express, node, postgres, react, rest, solid, tsringe, typeorm
- Language: TypeScript
- Homepage:
- Size: 1.48 MB
- Stars: 39
- Watchers: 2
- Forks: 8
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Hotseat
> Manage customers and services of your barber shop
> [Click here to see the database model](https://dbdiagram.io/d/5ebff54e39d18f5553ff4c44)
[](https://insomnia.rest/run/?label=Hotseat%20API&uri=https%3A%2F%2Fgithub.com%2FLauraBeatris%2Fhotseat-api%2Fblob%2Fmaster%2F.github%2Fdocs%2Finsomnia-workspace.json)
[](https://github.com/LauraBeatris)
[](#)
[](https://github.com/LauraBeatris/hotseat-api/stargazers)
[](https://github.com/LauraBeatris/hotseat-api/network/members)
[](https://github.com/LauraBeatris/hotseat-api/graphs/contributors)
# :pushpin: Table of Contents
* [Features](#rocket-features)
* [Installation](#construction_worker-installation)
* [Getting Started](#runner-getting-started)
* [FAQ](#postbox-faq)
* [Found a bug? Missing a specific feature?](#bug-issues)
* [Contributing](#tada-contributing)
* [License](#closed_book-license)
# :rocket: 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
# :construction_worker: Installation
**You need to install [Node.js](https://nodejs.org/en/download/) and [Yarn](https://yarnpkg.com/) 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](https://www.docker.com/) 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```
# :runner: 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```
# :postbox: Faq
**Question:** What are the technologies used in this project?
**Answer:** The technologies used in this project are [NodeJS](https://nodejs.org/en/) + [Express Framework](http://expressjs.com/en/) to handle the server and [TypeORM](https://typeorm.io/#/) as the Object Relational Mapper
# :bug: Issues
Feel free to **file a new issue** with a respective title and description on the the [Hotseat API](https://github.com/LauraBeatris/hotseat-api/issues) 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](https://github.com/LauraBeatris/hotseat-api/blob/master/CONTRIBUTING.md) to find out about the coding standards.
# :tada: Contributing
Check out the [contributing](https://github.com/LauraBeatris/hotseat-api/blob/master/CONTRIBUTING.md) page to see the best places to file issues, start discussions and begin contributing.
# :closed_book: License
Released in 2020.
This project is under the [MIT license](https://github.com/LauraBeatris/hotseat-api/master/LICENSE).
Made with love by [Laura Beatris](https://github.com/LauraBeatris) 💜🚀