Documentation update.

[pranav300]

Issue Description

Update documentation to have commands to quick start kaiju locally.

[itsdarrylnorris]

Hey @pranav300 ,

Do you know how to set it up locally? I am having issues getting working on my local environment.

[pranav300]

Do you know how to set it up locally? I am having issues getting working on my local environment.

You can run these commands in order to quick start kaiju,

docker build . -t kaiju
docker run -p 3000:3000 kaiju

But this will only run kaiju in non-persistent mode.

[itsdarrylnorris]

My issue was not entirely with Docker. I followed the instructions on the README, and the Redis containers do not seem to be appropriately connected with the Rails app. I just installed Redis directly OS, and that seems to fix the issue with Redis.

However, the latest issue I ran into is that the CSS does not seems to load in the page. This is how the page looks like, which is nothing like the gif in the README.md:

Have you run into this issue with the CSS not loading? I am not seeing any networks request failing.

[pranav300]

Did you use the commands that I had posted?

[StephenEsser]

Hi @itsdarrylnorris, glad to see you're interested in Kaiju. Apologizes for the state of the documentation. If I get a few free minutes sometimes this week I will look into getting the ReadMe updated.

In the meantime if you simply want to demo the application you can use the docker steps Pranav mentioned above.

[itsdarrylnorris]

Did you use the commands that I had posted?

@pranav300 I did not follow your steps, I was following the README.md. I will poke around later today and see if with your steps fixes the css issue.

In the meantime if you simply want to demo the application you can use the docker steps Pranav mentioned above.

@StephenEsser Cool, thanks

[StephenEsser]

Hi @itsdarrylnorris, I've made several changes since last week. The css issues you were experiencing should be resolved now if you pull down the latest changes and do a bundle install and an npm install from the root directory. If you are running an existing copy of the project make sure to either run the clean install command (npm run clean:install) or manually delete the node_modules directory from client/node_modules and run npm install again. If you want to give it another try let me know how it goes.

[itsdarrylnorris]

Hey @StephenEsser ,

Thank you for fixing the css issue. Everything seems to be working as expected.