ekiim/grillo-ruby-neo4j-challenge
1
0
Fork 0
Code Releases Activity

Added readme video

Browse Source
This commit is contained in:
Miguel Salgado 2023-05-23 21:32:28 -07:00
parent a632cc704f
commit d335531e67
1 changed files with 10 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@ -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)