From 74ef76596e3007f96a6655631700e89996b5a24a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Pawe=C5=82=20Placzy=C5=84ski?= <placzynski.pawel@gmail.com>
Date: Thu, 1 Feb 2024 12:39:49 +0100
Subject: [PATCH] [#97] Update backend and frontend READMEs for naming
 conventions

This commit involves updating the README.md files for both the backend and
frontend components of the GovTool project. These changes are part of the
ongoing efforts for ticket #85, ensuring that all references to the old 'vva-be'
and 'vva-fe' codenames are replaced with the new 'backend' and 'frontend'
naming convention. This is a continuation of the work done by @adgud, aiming to
maintain consistency across the project's documentation and directory structure.
---
 govtool/backend/README.md  |  6 +++---
 govtool/frontend/README.md | 24 ++++++++++++------------
 2 files changed, 15 insertions(+), 15 deletions(-)

diff --git a/govtool/backend/README.md b/govtool/backend/README.md
index ae36a75b9..d4ed15c3c 100644
--- a/govtool/backend/README.md
+++ b/govtool/backend/README.md
@@ -3,7 +3,7 @@
 This is a backend application of GovTool project.
 
 ## Prerequisites
-In order to run `vva-be` your host machine will need access to the `cardano-db-sync` postgres database. To have this database running locally you'll need:
+In order to run `backend` your host machine will need access to the `cardano-db-sync` postgres database. To have this database running locally you'll need:
 * `cardano-node`
 * `cardano-db-sync`
 * PostgreSQL database
@@ -24,10 +24,10 @@ Due to problems with openapi3 package it's hard to build this project with plain
 
 1. Get [Nix](https://nixos.org/download).
 
-2. Enter `src/vva-be` directory:
+2. Enter `govtool/backend` directory:
 
     ```sh
-    cd src/vva-be
+    cd govtool/backend
     ```
 
 3. Allow broken nix packages
diff --git a/govtool/frontend/README.md b/govtool/frontend/README.md
index 5d30306e4..d8ace9d3b 100644
--- a/govtool/frontend/README.md
+++ b/govtool/frontend/README.md
@@ -1,4 +1,4 @@
-# Voltaire GovTool Frontend
+# GovTool Frontend
 
 Installed on your machine:
 
@@ -16,7 +16,7 @@ Fill .env based on env.example file
 Go to the project directory
 
 ```bash
-  cd voltaire-era/src/vva-fe
+  cd voltaire-era/govtool/frontend
 ```
 
 Install dependencies
@@ -47,10 +47,10 @@ yarn dev
 
 1. Get [Nix](https://nixos.org/download).
 
-2. Enter `src/vva-fe` directory:
+2. Enter `govtool/frontend` directory:
 
 ```sh
-cd src/vva-fe
+cd govtool/frontend
 ```
 
 3. Run `nix-shell`
@@ -75,13 +75,13 @@ Install [`direnv`](https://direnv.net/):
 nix-env -i direnv
 ```
 
-Allow direnv configuration in `src/vva-fe`:
+Allow direnv configuration in `govtool/frontend`:
 
 ```sh
-direnv allow src/vva-fe
+direnv allow govtool/frontend
 ```
 
-From now on, once you enter the `src/vva-fe` the `nix-shell` with proper
+From now on, once you enter the `govtool/frontend` the `nix-shell` with proper
 configuration will be propagated.
 
 ## Developing
@@ -128,9 +128,9 @@ npm run dev
 
 1. Get [Nix](https://nixos.org/download).
 
-2. Enter `src/vva-fe` directory:
+2. Enter `govtool/frontend` directory:
 ```sh
-cd src/vva-fe
+cd govtool/frontend
 ```
 
 3. Run `nix-shell`
@@ -152,12 +152,12 @@ Install [`direnv`](https://direnv.net/):
 nix-env -i direnv
 ```
 
-Allow direnv configuration in `src/vva-fe`:
+Allow direnv configuration in `govtool/frontend`:
 ```sh
-direnv allow src/vva-fe
+direnv allow govtool/frontend
 ```
 
-From now on, once you enter the `src/vva-fe` the `nix-shell` with proper
+From now on, once you enter the `govtool/frontend` the `nix-shell` with proper
 configuration will be propagated.
 
 ### Users