ImageBox is a service that is used to upload files that are uploaded to an external Object Storage. You can only upload images in png & jpeg formats, no larger than 10 mb.
This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these example steps.
- Clone the repository:
git clone https://github.com/zenorachi/image-box
- Setup environment variables (create .env file in the project's root):
export DB_HOST=
export DB_PORT=
export DB_USERNAME=
export DB_NAME=
export DB_SSLMODE=
export DB_PASSWORD=
export POSTGRES_PASSWORD=
export MINIO_ROOT_USER=
export MINIO_ROOT_PASSWORD=
export HASH_SALT=
export HASH_SECRET=
Note: if you build the project using Docker, setup DB_HOST=db (as the container name)
- Compile and run the project:
make
- Go to
http://localhost:8080/docs/index.html
and test the ImageBox API.