Workspace Service

Provides APIs to help manage workspace resources such as Guacamole.

Getting Started

Prerequisites

This project is using Poetry to handle the dependencies. Installtion instruction for poetry can be found at https://python-poetry.org/docs/#installation

Installation & Quick Start

1. Clone the project.

   git clone https://github.com/PilotDataPlatform/workspace.git
   

2. Install dependencies.

   poetry install
   

3. Add environment variables into .env. Use .env.schema as a reference.

4. Run application.

   poetry run python start.py
   

Startup using Docker

This project can also be started using Docker.

1. To build and start the service within the Docker container, run:

   docker compose up
   

Contribution

You can contribute the project in following ways:

• Report a bug.
• Suggest a feature.
• Open a pull request for fixing issues or adding functionality. Please consider using pre-commit in this case.