diff --git a/README.md b/README.md index 7db80e4..fb355e7 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,15 @@ -# README +> *NOTE*, this project uses [`just`](https://just.systems/man/en/) as a task runner, and `docker compose` in order to spin up a `neo4j` database. -This README would normally document whatever steps are necessary to get the -application up and running. +Once you make sure you have just install you can run: -Things you may want to cover: +``` +$ just build +$ just migrate +$ just run +``` -* Ruby version +Beware that `migrate` might fail the first time, because `neo4j` takes longer to start during it's first execution. -* System dependencies +If you want to verify the functionality, you could try and opening the postman collection `Grillo Rails Test.postman_collection.json`, which contains collection variables to parametrize the actual endpoint for the rails api. -* Configuration - -* Database creation - -* Database initialization - -* How to run the test suite - -* Services (job queues, cache servers, search engines, etc.) - -* Deployment instructions - -* ... +[Here is a demo video](https://youtu.be/G4j8IrI8noQ)