Overview

The Binary Coffee API is an application that serves as the API for the website binary-coffee.dev. It is based in strapi and allows for various functionalities related to the website. This article provides information on setting up the project, running tests, contributing to the project, and supporting the community.

Features

• Docker-based installation for easy setup
• Command line installation option
• Environment variables for customization
• Contribution guide for community involvement
• Multiple donation methods for supporting the community

Installation

1. Before starting the project, ensure that mongodb is properly working on port 27017. Alternatively, you can use the provided database configuration in the blog-database repository.
2. To start the project via Docker, follow the appropriate steps.
3. To start the project via the command line, use the provided commands.
4. Set the required environment variables for customization:
   • DATABASE_NAME: database name (default: blog-dev)
   • DATABASE_HOST: database host (default: 127.0.0.1)
   • DATABASE_PORT: database port (default: 27018)
   • DATABASE_USERNAME: database username (optional)
   • DATABASE_PASSWORD: database password (optional)
   • CAPTCHA_SECRET: secret used for generating the captcha
   • API_URL: API URL
   • SITE_URL: website URL

Summary

The Binary Coffee API is a powerful tool for managing various functionalities of the binary-coffee.dev website. It provides easy installation options, customization through environment variables, and opportunities for community involvement and support. With its features and flexibility, it is a valuable asset for the website and its users.