Project Setup

What is Project Setup?

Project Setup is a Docker Compose-based development environment that provides a local server for connecting to external providers such as Google Drive. It is intended for developers who need a quick way to run and test integrations via a local API.

How to use Project Setup?

Run docker-compose up --build to start the server, which will be available at http://localhost:8080. Include an x-access-token header in API requests for authentication; optionally add an x-refresh-token header if required by the provider. A .env file must be created with the appropriate variables for each service (e.g., GOOGLE_CLIENT_ID and GOOGLE_CLIENT_SECRET for Google Drive).

Key features of Project Setup

• Docker Compose based for easy setup
• Supports multiple providers via .env configuration
• Uses x-access-token header for authentication
• Optional x-refresh-token header support
• Persistent data storage using Docker volumes

Use cases of Project Setup

• Quickly spin up a local API to test Google Drive integration
• Develop and debug authentication flows with external providers
• Create a reproducible development environment across team members

FAQ from Project Setup

What providers are supported?

The README explicitly mentions Google Drive as a supported provider, requiring GOOGLE_CLIENT_ID and GOOGLE_CLIENT_SECRET environment variables.

What are the runtime requirements?

Docker and Docker Compose must be installed. A .env file is needed only for the services you choose to use.

Where is data stored?

Data is stored in a Docker volume named app_data (persistent between container restarts).

How do I authenticate requests?

Pass an x-access-token header with your access token. Optionally include an x-refresh-token header if required by the server.

How do I stop the server?

Run docker-compose down to stop and remove the containers.