The readme was generated by the create-react-app command, this PR updates it with some bare minimal information to just get going.
Related Issues / PRs
Resolves: #16
Thought Process
I didn't want to include too many commands or recommendations on how to build and run the project. The basic ones are there along with how to install any dependencies required to run these projects locally. I also assumed some prior knowledge around how to clone the repo and so forth.
The latest versions of the tools is probably fine, and if there are any problems or if you need to work with the exact versions that are used in production, those are simple enough to find in the Dockerfiles or throughout the repo.
I didn't start from scratch to test the steps outlined in this readme, so it's possible I missed some. This won't affect the application, so if we need to update the readme or add more detail, we can do so as required. 👍
Overview
The readme was generated by the
create-react-appcommand, this PR updates it with some bare minimal information to just get going.Related Issues / PRs
Resolves: #16
Thought Process
I didn't want to include too many commands or recommendations on how to build and run the project. The basic ones are there along with how to install any dependencies required to run these projects locally. I also assumed some prior knowledge around how to clone the repo and so forth.
The latest versions of the tools is probably fine, and if there are any problems or if you need to work with the exact versions that are used in production, those are simple enough to find in the Dockerfiles or throughout the repo.
Testing Steps
Follow the steps to get up and running as outlined in the readme. You can preview how it will look here: https://github.com/bldg14/eventual/tree/kf/16-update-readme
Risks
I didn't start from scratch to test the steps outlined in this readme, so it's possible I missed some. This won't affect the application, so if we need to update the readme or add more detail, we can do so as required. 👍