Skip to content

Deploy your own instance

Jay edited this page Dec 9, 2021 · 3 revisions

Local Server / VPS

  1. Download and install Golang (here). Make sure it's added to your environment path.

  2. Clone the repository....

git clone https://github.com/jayluxferro/GhanaPostGPS-REST-API.git ghanapostgps
  1. Install dependencies.
cd ghanapostgps
go mod vendor
  1. Run in development mode
./dev
  1. Run in live mode
./live

NB:

  • Default port is 5001. Modify the 'run' scripts to change the default port. The API documentation is the same; replace the hostname with your instance's.

  • The default API keys are stored in the .env file. You can generate new keys here.

Heroku

  1. Clone the project.

  2. Create a new heroku project and add its git URL. Example is shown below:

    git remote add heroku https://myproject.heroku.git
  1. Push to the heroku instance.
    git push heroku master

Clone this wiki locally