https://github.com/artursantiago/gobarber-api
An API to manage Barbershop
https://github.com/artursantiago/gobarber-api
bcryptjs expressjs nodejs postgresql typeorm typescript
Last synced: 3 months ago
JSON representation
An API to manage Barbershop
- Host: GitHub
- URL: https://github.com/artursantiago/gobarber-api
- Owner: artursantiago
- License: mit
- Created: 2021-01-27T14:35:01.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-02-04T12:34:37.000Z (over 5 years ago)
- Last Synced: 2025-01-31T07:32:52.683Z (over 1 year ago)
- Topics: bcryptjs, expressjs, nodejs, postgresql, typeorm, typescript
- Language: TypeScript
- Homepage:
- Size: 125 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GoBarber API
> GoBarber API, an application that connects barbershops to customers in their regions.
[](https://github.com/artursantiago)
[](#)
[](https://github.com/artursantiago/gobarber-api/stargazers)
[](https://github.com/artursantiago/gobarber-api/network/members)
[](https://github.com/artursantiago/gobarber-api/graphs/contributors)
---
# :pushpin: Table of Contents
* [Features](#rocket-features)
* [Installation](#construction_worker-installation)
* [Getting Started](#runner-getting-started)
* [Built With](#pick-built-with)
* [Found a bug? Missing a specific feature?](#bug-issues)
* [Contributing](#tada-contributing)
* [License](#closed_book-license)
# :rocket: Features
* Route to create a new user
* Route to update user avatar
* Route to create a authenticated session
* Route to create a new appointment
* Route to get the user appointments
# :construction_worker: Installation
**You need to install [YARN](https://yarnpkg.com/) and [NODE](https://nodejs.org/es/) first, then in order to clone the project via HTTPS, run this command:**
```git clone https://github.com/artursantiago/gobarber-api.git```
SSH URLs provide access to a Git repository via SSH, a secure protocol. If you have a SSH key registered in your Github account, clone the project using this command:
```git clone git@github.com:artursantiago/gobarber-api.git```
**Install dependencies**
You need to install the dependencies of the project, so **run the above command on root and in each of this folders**:
```yarn```
# :runner: Getting Started
Run the following command to start the application in a development environment:
```yarn dev:server```
# :pick: Built With
- [Typescript](https://www.typescriptlang.org/)
- [Node JS](https://nodejs.org/en/)
- [Express JS](https://expressjs.com/)
- [Bcryptjs](https://www.npmjs.com/package/bcryptjs)
- [TypeORM](https://typeorm.io/)
- [Postgres](https://www.postgresql.org/)
# :bug: Issues
Feel free to **file a new issue** with a respective title and description on the [GoBarber API](https://github.com/artursantiago/gobarber-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/artursantiago/gobarber-api/blob/master/CONTRIBUTING.md) to find out about the coding standards.
# :tada: Contributing
Check out the [contributing](https://github.com/artursantiago/gobarber-api/blob/master/CONTRIBUTING.md) page to see the best places to file issues, start discussions and begin contributing.
# :closed_book: License
Released in 2021.
This project is under the [MIT license](https://github.com/artursantiago/gobarber-api/master/LICENSE).