Skip to content

Latest commit

 

History

History
executable file
·
29 lines (23 loc) · 1.27 KB

README.md

File metadata and controls

executable file
·
29 lines (23 loc) · 1.27 KB
Raw

Real-Time Locator API

This API is for a locator app that allows users to upload their location in real-time and see other users' locations in real-time. It is built using GoLang and runs on an AWS EC2 instance.

Installation

  1. Clone this repository using the command git clone https://github.com/CharlesMuchogo/locator/master.
  2. Navigate to the cloned directory using the command cd locator.
  3. Install the dependencies using the command go mod download.
  4. Rename the config-sample.yaml file to config.yaml.
  5. Update the config.yaml file with your desired configurations.
  6. Run the server using the command go run main.go.

Deployment

The API is deployed on an AWS EC2 instance. GitHub Actions is used to create a Docker image of the API and push it to DockerHub. The EC2 instance then pulls the latest Docker image and runs the API server.

Contributing

Feel free to submit pull requests or report issues. For major changes, please open an issue first to discuss what you would like to change.