Skip to content

Latest commit

 

History

History
78 lines (48 loc) · 2.31 KB

README.md

File metadata and controls

78 lines (48 loc) · 2.31 KB
Raw

Onde Hoje ?

A Single place to share the underground

Onde Hoje is an innovative application that allows users to share underground events in their city. This app is designed for people who are looking for unique experiences and want to explore the hidden gems of their city. With Onde Hoje, users can find events that are not advertised on mainstream platforms such as Facebook or Instagram. This app is perfect for those who want to discover new artists, musicians, and performers before they become mainstream.

image_alt_text

To run the API locally and start shipping 🚢 new features is easy:

# start running the development environment. For now, a PostgreSQL database.
make dev/start

After that, to run the API, apply the command:

go run cmd/ondehoje/main.go

API Requests

Just access your browser at http://localhost:8000/docs. That's it, all routes grouped in one place!

Core Concepts

Some concepts that this simple API will build under:

  • API
  • Database
  • Database Migration
  • Structured Logs
  • Dev Container environment
  • Go Unit test
  • Metrics
  • Swagger/OpenAPI

Structured Logs

It's important for each route that will be created, to pay attention to instantiate the right context logs and pass this object forward for each chain of code, including thirty implementations, like database interaction. The current routes already are following this pattern.

Heroku Database

Before connecting to the PostgreSQL database, make sure you have the Heroku CLI installed

sudo apt-get install postgresql  #to install psql

heroku pg:psql -a ondehoje # to access database and execute admin commands

Ship New code to production

Although there is a CI for that, it's possible to SHIP🚀 new code to production just using your machine.

Just run the following commands, in this order, and be happy😃:

make image
make publish
make heroku/release

Useful Vscode extensions

OpenAPI Swagger Editor