changed readme

.gitignore

@@ -30,6 +30,8 @@ share/python-wheels/
 *.egg-info/
 .installed.cfg
 *.egg
+.idea
+.idea/
 MANIFEST
 
 # PyInstaller

README.md

@@ -14,7 +14,8 @@ All database-level encryption/decryption and hashing are done using the `PGCRYPT
 
 1. Fully integrated frontend 
 
-![frontend](./static/frontend_first.png)
+![frontend](static/create_pass.gif)
+
 
 2. SwaggerUI documentation for the APIs.
 
@@ -29,16 +30,17 @@ All database-level encryption/decryption and hashing are done using the `PGCRYPT
 ## Setup
 
 After cloning the repository, generate the `SECRET_KEY` to be used for this
-application (requires `openssl`) and save it to some file.
+application (requires `openssl`) and copy to clipboard.
 
-```
-openssl rand -hex 30 > ~/.config/.opwm_config
+
+```bash
+openssl rand -hex 30 | xclip -selection clipboard
 ```
 
 Copy the `.env.example` to a new `.env` file and paste the `SECRET_KEY` into
 its corresponding key.
 
-```
+```bash
 cd /backend
 
 cp .env.example .env
@@ -47,18 +49,33 @@ cp .env.example .env
 Optionally, you can change the port numbers for the FastAPI server, the database
 and the Vue application by editing the `docker-compose.yml`.
 
-By default, these are:
+Default ports:
+
 ```
 database - 5400
 backend  - 8000
 frontend - 3333
 ```
 
-To connect to the container database, use the following URL.
+(Optional) To connect to the container database, use the following URL.
 ```
 psql postgresql://postgres:postgres@localhost:5400/opwm
 ```
 
+
+## Test
+
+
+```bash
+docker exec -it <CONTAINER-ID> python -m pytest -v tests
+```
+
+## Uninstall
+To remove the container and all its volumes
+```bash
+docker-compose down --rmi all --volumes --remove-orphans
+```
+
 ## Note
 
 - Please note that this is by no means a safe or secure implementation of password managers. There are other well-established software like `BitWarden` or `KeePassXC` which provide a much better solution. 
@@ -69,3 +86,7 @@ an end-to-end password storage software. Use it at your own risk.
 ---
 
 
+## Todo
+
+* Deploy on Heroku
+* Implement better testing functionality

docker-compose.yml

@@ -32,6 +32,7 @@ services:
     ports:
       - 8000:8000
 
+
   client:
     depends_on:
       - server
@@ -45,5 +46,6 @@ services:
     ports:
       - 3333:3333
     command: serve -s /frontend/dist -l 3333 
+
 volumes: 
   postgres_data: