Skip to content

Commit

Permalink
Update Justfile
Browse files Browse the repository at this point in the history
  • Loading branch information
mjanv committed Aug 25, 2023
1 parent 5d6596e commit 84a2176
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 7 deletions.
8 changes: 6 additions & 2 deletions .justfile
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,20 @@ start:
sleep 3
mix ecto.setup

# Start the notebooks (Livebook)
notebooks:
docker-compose up --detach livebook

# Stop the development stack
stop:
docker-compose down --volumes

# Run the application
app:
server: start
mix phx.server

# Run code quality and unit tests
tests:
tests: start
@mix quality
@mix test

Expand Down
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,16 +18,15 @@ To develop, you need to have [just](https://github.com/casey/just), [docker](htt
To run the web application for local development,

```bash
just start
just app
just server
```

### Notebooks

To help develop the application, you can use the notebooks accessible in the `notebooks/` folder. Any notebook can be displayed using the [local livebook](http://localhost:8080/open/file),

```bash
just start
just notebooks
```

### Tests
Expand All @@ -41,10 +40,18 @@ just tests

### Local demonstration

To run the application stack (Application, Livebook, [Grafana](http://localhost:3000)),
To run the full application stack (Application, Livebook, [Grafana](http://localhost:3000)) for demonstration purposes,

```bash
just app
```

### Local demonstration

All stacks (development, notebooks, demonstration) can be stopped using,

```bash
just docker
just stop
```

## Roadmap
Expand Down

0 comments on commit 84a2176

Please sign in to comment.