Skip to content

Social network API created with Node.js, Express, TypeScript, TypeORM and MySQL.

Notifications You must be signed in to change notification settings

pedrofnts/parrot

Repository files navigation

Parrot

This project consists of an API for a Twitter-like social network white label system.

Run in Insomnia

✨ Client

Parrot is a white label system for condominiums, to encourage interaction among the residents.
The platform allows users to make publications for the entire community.

🏗️ Back-end authors

  • Fabiana Boniolo de Oliveira
  • Pedro Fontes
  • Victor César Nery da Paixão

🏗️ Front-end authors

  • Bruno Andrade Lima de Araújo
  • Pedro Arruda

Repository: https://github.com/Brunoalaraujo/HandsOnParrot.git

📝 Features Created

  • Login (JWT Authentication)
  • Users CRUD
  • Posts CRUD

🚀 Techs

node typeorm typeorm-extension express mysql bcrypt jest jsonwebtoken supertest reflect-metadata

Local Project

To run this project locally, you'll need Git, Node and MySQL installed on your computer.

After cloning project, remember to insert your local database credentials into /.env.

# Clone this repository
$ git clone https://github.com/pedrofnts/parrot.git

# Go into the repository
$ cd parrot

# Install dependencies
$ yarn install

# Create database
$ yarn db:create

# Generate migrations
$ yarn migration:generate

# Run migrations
$ yarn migration:run

# Add seeds
$ yarn seed

# Run server
$ yarn run dev


# running on port 3000

📇 Body requisitions

  • create user
{ "name": string, "email": string, "apartment": number, "password": string }
  • create post
{ "content": string }

Made with 💚 by

🔹 Fabiana Boniolo de Oliveira 👋 Get in touch
🔹 Pedro Fontes 👋 Get in touch
🔹 Victor Nery 👋 Get in touch

🔸 Bruno Andrade Lima de Araújo 👋 Get in touch
🔸 Pedro Arruda 👋 Get in touch

About

Social network API created with Node.js, Express, TypeScript, TypeORM and MySQL.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages