Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improvements for Wiki / Local Development Setup #279

Open
Trojan13 opened this issue Jan 26, 2025 · 0 comments
Open

Improvements for Wiki / Local Development Setup #279

Trojan13 opened this issue Jan 26, 2025 · 0 comments

Comments

@Trojan13
Copy link

While setting up the project locally, I encountered some challenges and would like to propose improvements to streamline the process. Below are the details of the issues and potential fixes:
Issues Identified

Incomplete Setup via docker-compose
    The backend does not automatically start with docker-compose up. It needs to be started separately.
    Database migrations also need to be run manually.

Google Drive Folder Accessibility
    The Google Drive folder required for the project setup is not publicly accessible, causing issues for new developers.

Environment File Confusion
    The .env.dist file should be renamed or better documented to reduce confusion during setup.

Environment Variables Updates
    The default .env.dist file should include updated variables for smoother local development:
        Replace:

ELASTICSEARCH_HOST=localhost
DATABASE_HOST=localhost

with:

    ELASTICSEARCH_HOST=elasticsearch
    DATABASE_HOST=db

Elasticsearch Configuration

To simplify local development, additional settings are needed in the Elasticsearch configuration:

    - xpack.security.enabled=false
    - xpack.security.http.ssl.enabled=false  # Disable SSL for simplicity in local dev

Suggestions for Improvement

Update the docker-compose configuration to:
    Automatically start the backend service.
    Include database migrations in the startup process, potentially via an entrypoint script.

Make the Google Drive folder publicly accessible or provide alternative instructions for accessing the required resources.

Rename .env.dist to .env.example and update the documentation to guide developers on creating a .env file.

Update the .env.dist file with recommended configurations for local development.

Add the necessary Elasticsearch settings in the docker-compose environment section to simplify setup.

Expected Outcome

Implementing these changes will make it significantly easier for new developers to get started with the project, reducing friction and improving contributor experience.
Additional Notes

I'm happy to assist in implementing some of these changes if the maintainers agree with the suggestions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant