Skip to content
This repository has been archived by the owner on Nov 7, 2023. It is now read-only.

Commit

Permalink
docs: Update README (#19)
Browse files Browse the repository at this point in the history
* docs: Update `README` (#18)

---------

Co-authored-by: Antonio Donis <antoniojosedonishung@gmail.com>
  • Loading branch information
PedroChaparro and shoriwe authored Aug 20, 2023
1 parent 8acc252 commit 6caf6c5
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 11 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.

### 0.0.9 (2023-08-20)

### [0.0.8](https://github.com-university/hawks-atlanta/metadata-scala/compare/v0.0.7...v0.0.8) (2023-08-20)

### 0.0.7 (2023-08-20)
Expand Down
30 changes: 22 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,41 +6,55 @@

## Development

### Local database

You can run a local postgres database and pgadmin using the following command:

```bash
docker-compose -f docker-compose.dev.yml up
```

After that, you can access the pgadmin using the following url: `http://localhost:5050/` and the credentials:

| Email | Password |
| --------------------- | -------- |
| postgres@postgres.com | postgres |

### Create packages

You can create new packages with default folders (`domain`, `application`, `infraestructure` and `test`) using the following command:
You can create new packages with default folders (`domain`, `application`, `infraestructure` and `test`) using the following command:

```bash
make create
make create
```

After running the command you'll be prompted to enter the name of the package.

### Remove packages

You can remove packages using the following command:
You can remove packages using the following command:

```bash
make remove
make remove
```

After running the command you'll be prompted to enter the name of the package.

## Tests

1. Make sure you have `sbt` installed in your computer:
1. Make sure you have `sbt` installed in your computer:

```bash
sbt --version
```

2. Run the tests and generate the coverage report:
2. Run the tests and generate the coverage report:

```bash
sbt clean coverage test coverageReport
```

3. (Optional) Open the `html` coverage file located in:
3. (Optional) Open the `html` coverage file located in:

```bash
cd target/scala-2.13/scoverage-report
Expand All @@ -49,4 +63,4 @@ cd target/scala-2.13/scoverage-report
## Coverage

| [![circle](https://codecov.io/gh/hawks-atlanta/metadata-scala/graphs/sunburst.svg?token=M9CJCEEIBK)](https://app.codecov.io/gh/hawks-atlanta/metadata-scala) | [![square](https://codecov.io/gh/hawks-atlanta/metadata-scala/graphs/tree.svg?token=M9CJCEEIBK)](https://app.codecov.io/gh/hawks-atlanta/metadata-scala) |
| ------------------------------------------------------------ | ------------------------------------------------------------ |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@
"git-semver-tags": "^4.1.1",
"standard-version": "^9.5.0"
},
"version": "0.0.8"
"version": "0.0.9"
}

0 comments on commit 6caf6c5

Please sign in to comment.