kammradt/lets-meet-api

💚 A Meetup like API using NestJs: Welcome to Let's Meet!

Welcome to Let's Meet API ✌️

Goals 🗺️

Some time ago, I was interested on Typescript and building APIs with it, so I started a NestJs course. This project aims to apply what I learned, by creating a an API to a Meetup clone that I'm calling Let's meet!

Description 📝

Let's meet! is a study project aiming to be a simpler version of Meetup.

It will allow users to create, manage and organize events. You can verify more below!

Development progress 📊

I'm trying to follow gitflow, so you can see my progress usings the tags from this repository too! 😊

• Users module

  • Anyone should be able to register and become a User
  • Any User should be able to get own information
  • Admins should be able to retrieve information about all users
    • Create a custom PaginationOptions for listing users by role
  • Admins should be able to update a User role

• Auth module

  • Any User should be able to perform login and receiving a JWT to use in next requests.
  • This module should export authorization and authentication functionality for all other modules

• Events module

  • Regular Users should be able to create events with 50 max attendees
    • 100 attendees for Premium Users
  • Users should be able to retrieve their events
  • Users should be able to retrieve events that they are attending
  • Users should be able to edit the Event title, description, date, etc
  • Users should be able to cancel their Events
    • Admins should be able to cancel any Event
  • Events should be able to hold Users requesting to attend
  • Events should be able to hold Users requesting to exit from it
  • Admins and the Event owner can remove a User from a specific event
  • Users should be able to create comments, edit and delete comments on Events
    • Event owner and Admin and remove comments from any users
  • A scheduled job should be created to update events and mark them as DONE after current date is bigger than event endDate field

• Notifications module

  • Thinking about it 🤔

Try it out ❗

I mapped all API calls using Insomnia, so it is easier for testing flows while the front-end app is not completely ready.
To be easier for you, just import this file

How to use 🌐

API: https://api-lets-meet.herokuapp.com/
Web app: https://lets-meet.now.sh/
Web app repo

How to use 🏠

Database setup

We are using PostgreSQL 12.

• With docker: docker-compose up

• Local database: (look at /config/default.json)

    {
      "host": "localhost",
      "database": "letsmeet",
      "username": "postgres",
      "password": "postgres",
      "port": 5432
    }

---

API setup

We are using NestJS.

NestJS has a really usefull cli, I recommend you installing it!

$ npm install -g @nestjs/cli

Recommended TSC version: Version 3.9.3 Recommended Node version: v12.16.3 (It is easier to install using nvm!)

• Installing Node and Typescript:

   $ curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.35.3/install.sh | bash
   $ nvm install v12.16.3
   $ npm install -g typescript

• Running the API:

   $ npm run start:dev

• Running tests:

   $ npm run test

Help is always welcome 😉

Because as you can see, I have absolute no ideia what I'm doing 😆

How can I help?

• You can Fork this project and modify what you want. And then, send modifications using the Pull Request system.

What is and How to create a Fork?

• A Fork is basically a copy of this repository, but in your account. So, you have access to all files and can do whatever you want with your version. Using github is really easy to create a Fork, just follow:

You just need to click on Fork button on the top right!

What is and How to create a Pull Request?

• A Pull Request is a way of putting code from multiple people together in a organized way. After your modifications on your own forked repository, you can commit those changes and push to it. Now you have you repository updated with changes, but note that all those changes are only on your forked version. How to put your version together with mine and have a better project? Really easy! Just follow:

1. Go to the Pull Request tab
2. Click on new pull Request
3. You can verify the modifications
4. Click on Create pull Request
5. It is a good ideia to write a description of what was added
6. Create it! Thanks so much!

Author

👤 Vinicius Kammradt

• Website: https://kammradt.now.sh/

• Twitter: @kammzinho

• Github: @kammradt

• LinkedIn: @vinicius-kammradt