Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
- Add simpler descriptions
- Updated commands
- Add more information about services being used
  • Loading branch information
FloKnapp committed Nov 18, 2024
1 parent f92adfd commit 0ba4d2d
Showing 1 changed file with 18 additions and 12 deletions.
30 changes: 18 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,28 @@

# About this project

This application makes it possible for epilepsy patients to track their episodes.
This application let epilepsy patients track their episodes.

# Requirements

- PHP (on host)
- Git
- Docker

#### Services being used in Docker

- PHP 8.3
- MariaDB 11
- Mailpit (optional)
- Redis (optional)

# Installation

Clone this repository to your desired destination. Run the following commands afterward from the root directory of the application:
Clone this repository. Example:
```bash
git clone git@github.com:FloKnapp/laravel-11.git
```

Run the following commands from the root directory of the application (this could take a while):

```bash
$> ./vendor/bin/sail up -d
Expand All @@ -25,20 +37,14 @@ $> ./vendor/bin/sail artisan migrate

### Activate Watcher

This could take a while, when everything is finished get access to the container with the following command:

```bash
$> ./vendor/bin/sail root-shell
```

To watch for changes in the file system, execute the following command:
Start the vite bundler and file watcher:

```bash
root@9164ad43723c$> npm run dev
$> ./vendor/bin/sail npm run dev
```

# Run Tests

```bash
$> ./vendor/bin/phpunit -c phpunit.xml
$> ./vendor/bin/sail test
```

0 comments on commit 0ba4d2d

Please sign in to comment.