Skip to content

Commit

Permalink
AE-1935: Add top-level readme and tweak existing readme files to fit …
Browse files Browse the repository at this point in the history
…the monorepo
  • Loading branch information
Juholei committed Jan 3, 2024
1 parent a54e090 commit b76c011
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 9 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# ARA Energiatodistuspalvelu

The components of the system are:
- User interface for different stakeholders
- [etp-front/README.md](etp-front/README.md)
- [etp-public/README.md](etp-public/README.md)
- Backend / application layer
- [etp-core/README.md](etp-core/README.md)
- Database (PostgreSQL)
- [etp-core/README.md](etp-core/README.md)

7 changes: 1 addition & 6 deletions etp-core/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,6 @@
ARA - Energiatodistuspalvelu
===

The components of the system are:
- User interface for different stakeholders
- Backend / application layer
- Database (PostgreSQL)

Backend / Application layer
--------------
The backend contains the following components:
Expand All @@ -16,7 +11,7 @@ The backend contains the following components:
User interface
---------------

Separate repositories at https://github.com/solita/etp-front and https://github.com/solita/etp-public
See top-level directories etp-front and etp-public

Installing the development environment
-----------------------------
Expand Down
2 changes: 1 addition & 1 deletion etp-front/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ARA - Energiatodistuspalvelu
# ARA - Energiatodistuspalvelu frontend

Tämä on web sovellus energiatodistusten laadintaan
ja todistuksiin liittyvään viranomaistoimintaan.
Expand Down
4 changes: 2 additions & 2 deletions etp-public/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ARA - Energiatodistusrekisteri
# ARA - Energiatodistusrekisteri public frontend

*Note that you will need to have [Node.js](https://nodejs.org) installed.*

Expand All @@ -10,7 +10,7 @@ Install the dependencies...
npm install
```

You also need to start [backend](https://github.com/solita/etp-core) services found in different repository.
You also need to start [backend](../etp-core) services


...then start [webpack](https://webpack.js.org)
Expand Down

0 comments on commit b76c011

Please sign in to comment.