lotr-api icon indicating copy to clipboard operation
lotr-api copied to clipboard

Improve developer experience with better environment configuration

Open iisisrael opened this issue 2 years ago • 1 comments

I'm creating this issue as I plan to work on it myself, and I'm writing it out as one might in an agile-ish workflow for demo purposes elsewhere. Ignore to your heart's content.

User Story

As a consumer of the Lord of the Rings API I want developers of the API to have a smoother barrier of entry So that the ongoing maintenance and improvement of the API can have a broader community of contributors

Acceptance Criteria

  • Some form of development automation is configured in the project
  • Documentation explains how to manage the running of the environment

Scope of Work

  • Determine which virtualization technology is better: docker containers or the ??? configuration to automate a VM setup
    • Preferably docker
  • Add readme documentation to build, run, and stop the environment

Blueprint

  • TBD

iisisrael avatar Dec 07 '23 00:12 iisisrael

That's actually a good idea @iisisrael. I wanted to do something similar myself but started working on the migration to Typescript (for now only backend, the rest will follow) so will leave it to you. :)

MateuszKikmunter avatar Dec 07 '23 20:12 MateuszKikmunter

Done in #117

MateuszKikmunter avatar Apr 15 '24 20:04 MateuszKikmunter