An open API service indexing awesome lists of open source software.

https://github.com/bc-fullstack-03/william-lisboa-backend

Parrot is a social networking platform that allows users to communicate and share information with others.
https://github.com/bc-fullstack-03/william-lisboa-backend

Last synced: 8 months ago
JSON representation

Parrot is a social networking platform that allows users to communicate and share information with others.

Awesome Lists containing this project

README

          

# Parrot

This is the backend repository of the parrot application

## My docker image

This is the project docker file https://hub.docker.com/r/will763/parrot

## Run on your own machine

In the root of the project, you will find the docker compose file, to start the application run the following command:

```bash
docker compose up
```
This will start all the necessary services for the application.

## Usage

The application will be running the api locally, enter http://localhost:8080/swagger-ui/index.html and see the swaggwer documentation.

![Screenshot from 2023-05-09 17-24-23](https://github.com/bc-fullstack-03/william-lisboa-backend/assets/66382974/17bbc946-2795-4a8a-8dd0-7c1d7eebf625)

## :warning: Notice
After registering the user and logging in, you will need to set Token and userId in the headers for some routes.
#### Postman Headers

![Screenshot from 2023-05-09 15-20-38](https://github.com/bc-fullstack-03/william-lisboa-backend/assets/66382974/d5a00e82-4642-4593-b20c-153a2e09fcaf)

![Screenshot from 2023-05-09 15-08-16](https://github.com/bc-fullstack-03/william-lisboa-backend/assets/66382974/f596324b-a7b6-493a-84cd-bae28b4d7da0)

If you encounter any problems, please contact me or check the source code.

## Author

- Linkedin - [william](https://www.linkedin.com/in/william-dev/).
- Medium - [william](https://medium.com/@williamlisboa).