Welcome to BTC-Billionaire, a Go-based web server for handling POST and GET requests for Bitcoin transactions. This repository contains all the necessary code and instructions for setting up and running your own BTC-Billionaire server.
- Install
golang-migrateby running the following command:
go install -tags 'postgres' github.com/golang-migrate/migrate/v4/cmd/migrate@latest- Export an environment variable for convenience:
export POSTGRESQL_URL='postgres://postgres:password@localhost:5432/example?sslmode=disable'- Run the migrations based on what you need:
- To run migration up:
make migrate-up - To create a new migration file:
make migrate-create
-
Create
app.envbased on thesample.envfile. This file should contain all the necessary environment variables for the application to run properly. -
Run the unit tests by executing the command
make test. This will ensure that all the code is functioning as expected before running the server. -
Spin up the database using Docker based on the
docker-compose.ymlfile in the scripts directory. This file contains all the necessary configurations to run a local instance of the database.
make dependencies
# or
docker-compose -f scripts/docker-compose.yml up- Run the server using the command
make run. This will start the server and make it available on your specified port on localhost.
It is important to note that, you may need to modify the docker-compose.yml file to match with the database credentials and endpoint you are using. Also, make sure you have docker and docker-compose installed on your machine.
The BTC-Billionaire server exposes a simple RESTful API for creating and retrieving Bitcoin transactions.
You can find a Postman exported collection on the project root directory with the name BTC Billionaire.postman_collection.json You can import this collection into Postman to easily test the API endpoints and see examples of the expected request and response formats.
You can also visit this Postman URL to view the API Documentation.
This project is deployed to Google Cloud Run. The action can be viewed in the directory .github/workflows/deployment. The URL for the deployed application is: https://btc-billionaire-4w6hwgpraa-uw.a.run.app
This repository is using GitHub actions to automate the deployment process, You can manually trigger the deployment process by using the workflow_dispatch event in GitHub Actions. To do so, you will need to go to the Actions tab of your repository on GitHub, find the deployment workflow, and then click the "Run workflow" button and select "workflow_dispatch" from the dropdown menu. This will manually start the deployment process and deploy the latest version of the code.