Development Setup

This guide will help you set up your development environment for contributing to the Eyened platform.

Prerequisites

Before you begin, ensure you have the following installed:

• Node.js (v18 or later)
• Python (v3.8 or later)
• Docker and Docker Compose
• Git

Quick Start

To start the development environment:

cd dev
docker-compose up -d

This starts the database and fileserver services.

In separate terminals:

./start_client_dev.sh
./start_server_dev.sh

Now you can make edits to the client or server code, the application should update automatically.

Tip

Check the README in the dev folder for more details.

Note

If this is your first time running the development environment, you may need to:

1. Clone the repository:

   git clone https://github.com/Eyened/eyened-platform.git
   cd eyened-platform

2. Install server dependencies:

   cd ../server
   python -m venv venv
   source venv/bin/activate
   pip install -r requirements.txt

3. Create a .env file:

   cp sample.env .env

4. Install client dependencies:

   cd ../client
   npm install

5. Make the start scripts executable:

   chmod +x start_client_dev.sh start_server_dev.sh

Caution

The browser updates automatically when editing code, but sometimes the webgl context is outdated and you may need to refresh the page manually.

Caution

The FastAPI server doesn’t always restart automatically after code edits. You may need to manually restart the server in some cases.

Development Workflow

1. Create a new branch for your feature:

   git checkout -b feature/your-feature-name

2. Make your changes and test them locally

3. Push to the public repository and create a pull request

Caution

Never commit sensitive information like API keys or passwords to the repository. Use environment variables for all sensitive configuration.