OneBusAway / onebusaway-docs

Official developer documentation for OneBusAway
https://developer.onebusaway.org
8 stars 30 forks source link

feat: Dockerize for easy project setup and development. #76

Open ankitkumar748846 opened 8 months ago

ankitkumar748846 commented 8 months ago

Is your feature request related to a problem? Please describe

Currently manually installing and setting up each of the dependencies is bit cumbersome and sometimes have chances of project not running successfully

Describe the solution you'd like

Implement a Docker-based setup for development of the project. This will streamline the setup process, ensuring consistency and reliability across different development environments.

Describe alternatives you've considered

For now only docker setup is done for development environment if required dockerization can be done for production also.

Additional context

No response

Are you working on this?

Yes

ankitkumar748846 commented 8 months ago

@aaronbrethorst Please assign me this issue.

aaronbrethorst commented 8 months ago

Before you start working on this, can you elaborate on what aspects of setup are cumbersome and are sometimes failing for you?

ankitkumar748846 commented 8 months ago

@aaronbrethorst Sir, I switched to Linux because I encountered errors while installing Ruby on Windows and couldn't run the project successfully. Moreover, the project I was working on utilized an older version of Ruby, necessitating me to change the version each time, adding an extra step.

  1. Easy Setup : Eliminate the need for manual dependency installation on local machines. Avoid conflicts arising from different versions of Ruby.
  2. No need to install dependencies locally on PC
  3. Conflict with different versions of Ruby.
  4. Streamline setup purpose for different Operating System : Provide a seamless setup process tailored for various operating systems. Offer a straightforward setup method that accommodates users on Windows, mac-OS, and Linux systems.

Benefits

  1. One Command setup (For new Contributor)
  2. Open future scope for dockerize production deployment.
aaronbrethorst commented 8 months ago

Ok, that makes sense. Please update the readme with instructions on how to use this functionality

ankitkumar748846 commented 8 months ago

Definitely, I am going to do it, sir. @aaronbrethorst