https://github.com/leandroalcantara-1997/heroes-social-network
Heroes social network is a project created to make life easier for superhero fans.
https://github.com/leandroalcantara-1997/heroes-social-network
docker docker-compose golang graceful-shutdown jaeger postgresql redis splunk swagger
Last synced: 7 months ago
JSON representation
Heroes social network is a project created to make life easier for superhero fans.
- Host: GitHub
- URL: https://github.com/leandroalcantara-1997/heroes-social-network
- Owner: LeandroAlcantara-1997
- License: mit
- Created: 2023-03-13T23:53:20.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-22T00:07:22.000Z (over 1 year ago)
- Last Synced: 2025-03-10T23:39:27.807Z (8 months ago)
- Topics: docker, docker-compose, golang, graceful-shutdown, jaeger, postgresql, redis, splunk, swagger
- Language: Go
- Homepage: https://www.linkedin.com/in/leandro-alcantara-pro
- Size: 1.59 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Heroes Social Network
[README in Portuguese](README_pt.md)
## About
Heroes social network is a project created to make life easier for superhero fans, offering resources such as:
1. Search for character characteristics;
2. Team to which characters belong;
3. HQ data;
4. Games, Movies and Series Data;
## Here you will find characters from companies such as:
## How to execute
1. Run:
~~~ make
make docker-up
~~~
## To configure splunk
To configure [Splunk](http://localhost:8000/), access the platform in settings -> data inputs -> HTTP Event Collector -> Global Settings and disable SSL.
|[ENVIRONMENTS](build/.env.example) | EXAMPLE VALUES |
|--------------------|--------------------------------------------------|
|API_PORT | 8080 |
|DB_NAME | heroes |
|DB_USER | user |
|DB_PASSWORD |passw0rd |
|DB_HOST |postgres-database |
|DB_PORT |5432 |
|SPLUNK_PASSWORD |passw0rd |
|SPLUNK_HOST |http://splunk:8088 |
|SPLUNK_TOKEN |e26c8b3f-fe44-490c-82f9-22c5bf8ab3b5 |
|SPLUNK_ASSYNC |false |
|CACHE_HOST |redis-cache |
|CACHE_PORT |6379 |
|CACHE_PASSWORD |passw0rd |
|CACHE_READ_TIMEOUT |2 |
|CACHE_WRITE_TIMEOUT |2 |
|ALLOW_ORIGINS |http://localhost:3000,https://localhost:8080|
|OTEL_EXPORTER_OTLP_ENDPOINT |http://jaeger:4318 |
|ENVIRONMENT |local |
|SERVICE_NAME |heroes-social-network |
#### To access the API contracts, run the application and access http://localhost:8080/swagger/index.html#/, or import the [swagger.yaml](/docs/swagger.yaml) file into the [swagger editor](https://editor.swagger.io/) or import the [Heroes-social-network.postman_collection.json](/docs/heroes-social-network.postman_collection.json) file into Postman .For more information about the project, visit: [Wiki](https://github.com/LeandroAlcantara-1997/heroes-social-network/wiki)
## Technologies
* Golang 1.20;
* PostgreSQL;
* Redis as cache;
* Splunk;
* Traces with Jaeger;
* OpenTelemetry;
* Swagger;
* Graceful shutdown;
* Dev Container with Docker;
## Entity relationship diagram
