You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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:
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.
The text was updated successfully, but these errors were encountered:
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
ELASTICSEARCH_HOST=localhost
DATABASE_HOST=localhost
with:
Elasticsearch Configuration
Suggestions for Improvement
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.
The text was updated successfully, but these errors were encountered: