Code Monkey home page Code Monkey logo

boa-hancock-api's Introduction

Boa Hancock Api

image

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

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

Install dependencies

  pnpm i

Run server

  pnpm start:dev

Open prisma studio to access and alter database

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 <name_branch>.
  3. Make the changes and confirm: git commit -m '<message_commit>'
  4. Send to original repository: git push origin <main_branch> / <local>
  5. Send the pull request.

Alternatively, see the GitHub documentation at how to create a pull request.

GitHub repo size GitHub language count GitHub forks Bitbucket open issues Bitbucket open pull requests

🤝 Contributors

Made with ❤️ by:

Foto do Rodrigo Victor no GitHub
Rodrigo Victor 		Foto do Gustavo Abel no GitHub
Gustavo Abel

boa-hancock-api's People

Contributors

gustavoabel avatar rodrigorvsn avatar

Stargazers

avatar

Watchers

avatar avatar

boa-hancock-api's Issues

[Profile] - Add User Info

  • Should be able to add favorite programming languages
  • Should be able to add favorite frameworks (?)
  • Should be able to add hobbies
  • ... (feel free to add more :D)
  • Should be able to return the user info in the User Schema (Matchs screen, Details Screen)

[Infra] - Add Redis cache

  • Add cache layer with redis
  • Create docker image
  • Apply cache layer with redis in existing get routes

[Infra] Deploy

  • Deploy node server (Railway / render)
  • Deploy database (Planetscale / RDS Aws) - PostgreSQL

[Match] Users match flow

  • [DB] - Adapt Database to register matches
  • [GET - User - 200] - Should be able to return a random user registered in the application
    Should be able to return if the person liked you before, in the User Json, to render a Match Feedback in Frontend
  • [POST - Like - 201] - A user should be able to give a Like to Another User
  • A user should be able to give a Deslike to Another User
  • Should be able to return in the Post route if is a match
  • A user should be able to match with another user
  • A user should not be able to match with the same user

[Profile] Edit User Info

  • [PUT - 200] Should be able to change the User Profile Picture (use S3 from AWS?)
  • [PUT - 200] Should be able to change the name
  • [PUT - 200] Should be able to edit bio

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.