From 16825071b3625b4d66539c0d8bcd3cd13256dbaa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maciej=20Krzy=C5=BCanowski?= Date: Mon, 27 Feb 2023 16:56:13 +0100 Subject: [PATCH] Added README.md --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..d282f66 --- /dev/null +++ b/README.md @@ -0,0 +1,10 @@ +# skrytka.app +To start this application you need to: +1. Configure database + - Install PostgreSQL DBMS + - Setup some database and user with permissions to it + - Create .env file in the main directory and fill it in with fields DB_USER, DB_PASS, DB_HOST, DB_PORT and DB_NAME. In case of confusion you may check exemplary .env file saved as .env.example in the root directory of this repository. +2. Run both SQL scripts, which are located in the main directory. For app to be usable it is also recommended to insert some data to the database. +3. Run `npm start` in the main directory +4. Run `npm start` in the client/ directory +5. App will run on localhost:3000