Local Development Environment Setup for Homebase Project

[benefacto]

This issue is created to assist new team members in setting up their local development environment for the Homebase project. The aim is to ensure a smooth onboarding process and provide clear instructions for getting all necessary components up and running locally.

Instructions:

1. Clone Necessary Repositories:

   • Homebase front end
   • Homebase-indexer
   • baseDAO-dockerized
   • Homebase-lite-app (note: deprecated, but still might be useful for reference)
   • Homebase-lite-backend

2. Set Up Local Development for Each Repository:

   • For each repository, follow the README instructions or any existing setup documentation.
   • Ensure all dependencies are installed. Use Node.js, Python, and TypeScript as required by different components of the project.

3. Integrate with Local Databases and Services:

   • Set up a local MongoDB instance for Homebase-lite-backend.
   • Configure local instances of any other services used (e.g., local blockchain nodes if necessary).

4. Environment Configuration:

   • Configure environment variables and any necessary API keys as per project requirements.
   • Make sure to align configurations with the current development standards of the project.

5. Testing Framework and CI/CD Pipeline:

   • Although not part of local setup, familiarize yourself with the testing framework and how it integrates with the CI/CD pipeline.
   • Look into how local changes can be tested before being pushed to remote repositories.

6. Access to Necessary Tools and Platforms:

   • Ensure access to Netlify, Heroku, Sentry, Papertrail, and other tools used in the project.
   • Check access to the Gitbook and Zenhub board for project management and documentation.

7. Local Testing and Development:

   • Run each component individually to ensure they are working as expected.
   • Test the interaction between different components (e.g., front end with backend APIs).

8. Review and Familiarize with Project Documentation:

   • Read through the project's Gitbook for an overview of the architecture and workflow.
   • Familiarize yourself with the Zenhub board to understand current tasks and project pipeline.

9. Questions and Troubleshooting:

   • List any issues or roadblocks encountered during the setup process.
   • Seek assistance in the #kevin channel in Homebase Discord for specific queries.

Additional Notes:

• Be aware of the differences between v2 and v3 implementations of certain components.
• Pay attention to deprecated sections like Homebase-lite-app for historical context but focus on current implementations.
• Remember to check branch naming conventions and PR processes for each repository.

Please update this issue with any challenges faced during the setup process or additional instructions that might be helpful for future onboarding.

[benefacto]

Still waiting on obtaining the .env for homebase for another one of the devs

[benefacto]

Related developer onboarding improvement issues:

• baseDAO-dockerized: Add Docker Compose Support for Local Development #735
• homebase-indexer: Expand README and Add Docker Compose Setup #736
• homebase-lite-app: Update README and Archive Repository
• homebase-lite-backend: Enhance README, Add Docker Compose and NVM Support

[benefacto]

Still need the .env

[benefacto]

Was able to get Netlify access in order to get the .env (though there seem to be a lot of production only keys)