https://github.com/rodrigorvsn/boa-hancock-api

👨‍💻 A application to find your Pair Programming Buddy. Based in Tinder.
https://github.com/rodrigorvsn/boa-hancock-api

architecture github-oauth jwt nest prisma redis rest-api socket-io swagger tinder typescript

Last synced: about 2 months ago
JSON representation

👨‍💻 A application to find your Pair Programming Buddy. Based in Tinder.

Host: GitHub
URL: https://github.com/rodrigorvsn/boa-hancock-api
Owner: RodrigoRVSN
Created: 2022-11-13T01:09:52.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2023-02-09T01:32:45.000Z (over 3 years ago)
Last Synced: 2025-07-31T02:23:22.997Z (10 months ago)
Topics: architecture, github-oauth, jwt, nest, prisma, redis, rest-api, socket-io, swagger, tinder, typescript
Language: TypeScript
Homepage:
Size: 235 KB
Stars: 1
Watchers: 2
Forks: 0
Open Issues: 6
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# Boa Hancock Api

![image](https://user-images.githubusercontent.com/75763403/202018120-b5cccba4-5509-4a97-9f9a-3c401fa47127.png)

___
> This is the API for our Tinder application for Devs find their pair programming matched.
___
## 💻 Prerequisites

- Install LTS Node version.
- Fill the `.env` file, following the `.env.example`.

___
## 🛠 Tools used

- Typescript
- Nest
- Prisma ORM
- Passport
- JWT + Github OAuth Strategy
- Redis cache
- Swagger documentation
- Socket.io websockets

___

## 🚀 Installing boa-hancock-api

#### Clone repository

```powershell
git clone https://github.com/RodrigoRVSN/boa-hancock-api.git
```

#### Install dependencies

```powershell
pnpm i
```

#### Run server

```powershell
pnpm start:dev
```

#### Open prisma studio to access and alter database

```powershell
pnpm prisma studio
```

___

## 📫 Contribuiting with boa-hancock-api

To contribue with boa-hancock-api, follow the steps:

1. Fork this repository.
2. Create a branch: `git checkout -b `.
3. Make the changes and confirm: `git commit -m ''`
4. Send to original repository: `git push origin / `
5. Send the pull request.

Alternatively, see the GitHub documentation at [how to create a pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request).

___

![GitHub repo size](https://img.shields.io/github/repo-size/rodrigorvsn/boa-hancock-api?style=for-the-badge)
![GitHub language count](https://img.shields.io/github/languages/count/rodrigorvsn/boa-hancock-api?style=for-the-badge)
![GitHub forks](https://img.shields.io/github/forks/rodrigorvsn/boa-hancock-api?style=for-the-badge)
![Bitbucket open issues](https://img.shields.io/bitbucket/issues/rodrigorvsn/boa-hancock-api?style=for-the-badge)
![Bitbucket open pull requests](https://img.shields.io/bitbucket/pr-raw/rodrigorvsn/boa-hancock-api?style=for-the-badge)

___

## 🤝 Contributors

Made with ❤️ by:

_{Rodrigo Victor}

_{Gustavo Abel}