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

feat: simplifying dev environment and required infra/services #340

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

kiraum
Copy link

@kiraum kiraum commented May 12, 2024

Creating a simple and straightforward development environment and infrastructure is crucial for attracting contributors to the project. I can attest to this based on my own experience when I decided to explore some of the open issues.

With this setup, any developer can create the environment using just three commands, assuming they already have Docker and Docker Compose pre-installed, without needing extensive knowledge of the required infrastructure:

# clone the repository
git clone [email protected]:NLNOG/irrexplorer.git`
# go to the dev directory
cd dev/
# start the development environment
docker-compose -f docker-up -d

The existing configurations, with minimal modifications, can also be used by those who need to deploy the IRR Explorer and IRRd4 services locally.

In a nutshell, the changes I am making include:

  • Updating the documentation with the necessary instructions for setting up the development environment and testing changes;
  • Adding scripts, configurations, Dockerfiles, docker-compose.yml, and other files required to create the development environment;
  • Updating .gitignore to prevent the inclusion of unexpected files in commits;
  • Creating a Makefile to assist with common daily operations.

Dependencies/blockers:
I have created PR#339 to add py312 support to the IRR Explorer. We need this PR to be merged for the development environment to work as expected. If it is not accepted, we can fall back to using older Python versions, although that is not the ideal scenario.

Thank you for this fantastic project!

@kiraum
Copy link
Author

kiraum commented Sep 28, 2024

Should I keep or close this PR? If no answers, I will move forward and close it.

@teunvink
Copy link
Member

We have a meeting with our external developer next week on bugs, features and works for IRR Explorer in which we will also discuss this PR as well.

@mxsasha mxsasha self-assigned this Sep 30, 2024
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

Successfully merging this pull request may close these issues.

3 participants