diff --git a/CHANGELOG.md b/CHANGELOG.md index bd9384e..92e9cb0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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) diff --git a/README.md b/README.md index eeb20e8..018d517 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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) | -| ------------------------------------------------------------ | ------------------------------------------------------------ | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------- | diff --git a/package-lock.json b/package-lock.json index 767b1c4..c613eb2 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,11 +1,11 @@ { "name": "metadata-scala", - "version": "0.0.8", + "version": "0.0.9", "lockfileVersion": 3, "requires": true, "packages": { "": { - "version": "0.0.8", + "version": "0.0.9", "devDependencies": { "git-semver-tags": "^4.1.1", "standard-version": "^9.5.0" diff --git a/package.json b/package.json index b5444f4..65fd999 100644 --- a/package.json +++ b/package.json @@ -3,5 +3,5 @@ "git-semver-tags": "^4.1.1", "standard-version": "^9.5.0" }, - "version": "0.0.8" + "version": "0.0.9" }