originalmk/skrytka-app
1
0
Fork 0
mirror of https://github.com/originalmk/skrytka-app.git synced 2024-11-20 10:28:50 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Added README.md

Browse Source
This commit is contained in:
Maciej Krzyżanowski 2023-02-27 16:56:13 +01:00
parent d3cb420018
commit 16825071b3
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md Normal file
View File

@ -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