originalmk/skrytka-app
1
0
Fork 0
mirror of https://github.com/originalmk/skrytka-app.git synced 2024-10-03 12:26:09 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
originalmk 2023-03-15 16:57:37 +01:00 committed by GitHub
parent 7bf9684946
commit 25d65b2db4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -5,10 +5,11 @@
**Be aware that this app is not stable yet and new commits may introduce breaking changes** **Be aware that this app is not stable yet and new commits may introduce breaking changes**
To start this application you need to: To start this application you need to:
1. Configure database 1. Configure database
- Install PostgreSQL DBMS - Install PostgreSQL DBMS
- Setup some database and user with permissions to it - 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. - Create .env file in the main directory and fill it in with fields DB_USER, DB_PASS, DB_HOST, DB_PORT, DB_NAME and COOKIE_SECRET. 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. 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.
- Note: Images should be added in media/images directory and image paths inserted into database should only contain part starting with images/ for example image may be uploaded at media/images/wozLEFT.webp and path in database should be images/wozLEFT.webp. - Note: Images should be added in media/images directory and image paths inserted into database should only contain part starting with images/ for example image may be uploaded at media/images/wozLEFT.webp and path in database should be images/wozLEFT.webp.
3. Run `npm install` in the main directory. 3. Run `npm install` in the main directory.
@ -17,4 +18,5 @@ To start this application you need to:
- You need to do this after every update of app's frontend (you can do it every time you pull new version of this app). - You need to do this after every update of app's frontend (you can do it every time you pull new version of this app).
6. Run `npm start` in the main directory 6. Run `npm start` in the main directory
7. App will run on localhost:5000 7. App will run on localhost:5000
Note: pm2 or/and nginx may be used to run this app for production Note: pm2 or/and nginx may be used to run this app for production