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

chore(env): automate setup process #155

Open
JowiAoun opened this issue Oct 16, 2024 · 2 comments
Open

chore(env): automate setup process #155

JowiAoun opened this issue Oct 16, 2024 · 2 comments

Comments

@JowiAoun
Copy link
Collaborator

JowiAoun commented Oct 16, 2024

🆘 What is the problem at hand?

Contributors have to setup their development environment to start contributing. The setup process found in our installation documentation (as of 2024-12-02) has many steps, and could be reduced down. We could automate setting up development environments, and potentially environment secrets.

  • The development environment can contain features that make development easier for this specific project.
  • For secrets, automating would mean creating and retrieving secrets with only a few commands.

This issue should implement the most appropriate way to proceed with the above.

🚀 What is the impact of the problem? How is this problem important? How does it affect users/developers?

We have had issues where Node.js is installed a different way on one contributor's system, causing builds to fail on their environment. That is why we need a setup process, preferably with Docker & dev containers.

The setup process has many steps, and is largely dependent on the contributor's development system. That's why setting up the development environment for contributors will greatly reduce the likelihood for issues to be system related.

Additionally, requirements for environment variables may grow as we expand on services used, therefore more time from contributors will be spent setting up & updating environment variables. Automating the process of setting up these variables also reduces user error.

@github-project-automation github-project-automation bot moved this to 💀 Backlog in 🐞 2025 Oct 16, 2024
@JowiAoun JowiAoun changed the title chore(scope-of-issue): description chore(env): automate process of setting up environment variables Oct 16, 2024
@MFarabi619 MFarabi619 changed the title chore(env): automate process of setting up environment variables chore(env): automate setup process Oct 19, 2024
@JeremyFriesenGitHub
Copy link
Contributor

would this kinda get refactored into creating containers/dev environment containers?

@JowiAoun
Copy link
Collaborator Author

JowiAoun commented Dec 3, 2024

would this kinda get refactored into creating containers/dev environment containers?

Yes, thanks for mentioning it. I have updated the description to reflect this change.

@HasithDeAlwis HasithDeAlwis moved this from 📋 Backlog to 🏗 In Progress in 🐞 2025 Dec 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 🏗 In Progress
Development

No branches or pull requests

3 participants