Skip to content

Commit

Permalink
[#97] Update backend and frontend READMEs for naming conventions
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
placek committed Feb 1, 2024
1 parent dc58e72 commit 74ef765
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 15 deletions.
6 changes: 3 additions & 3 deletions govtool/backend/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
24 changes: 12 additions & 12 deletions govtool/frontend/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Voltaire GovTool Frontend
# GovTool Frontend

Installed on your machine:

Expand All @@ -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
Expand Down Expand Up @@ -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`
Expand All @@ -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
Expand Down Expand Up @@ -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`
Expand All @@ -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
Expand Down

0 comments on commit 74ef765

Please sign in to comment.