AlecsisDuarte / crossing-api

Simple, fast and reliable RESTful API to fetch information about U.S. border's wait times using Golang

Crossing API

Simple, fast and reliable RESTful API to fetch information about U.S. border's wait times.

Getting Started

This project requires a Firebase account in order to store all ports related information.

1. Create Firebase project
2. Create test database within your firebase project
3. Download the database private key using this tutorial
4. Create an account in Currency Layer and copy the API access key
5. Create your .env file with this keys:

   PRODUCTION = <BOOL> //Set TRUE if running a production environment
   DATABASE_URL = <STRING> //URL towards your created Database
   SERVICE_ACCOUNT_KEY_PATH = <STRING> //Relative path to the private key
   CURRENCY_LAYER_ACCESS_KEY = <STRING> // Access key from currencylayer.com

5. Run with go run main.go
6. Go to localhost:8080

License

This project is licensed under the MIT license.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in crossing-go by you, shall be licensed as MIT, without any additional terms or conditions.