skrytka-app/README.md

![Logo skrytki](skrytka-small.png)
# skrytka.app
![Badge z licencją AGPL-3.0](https://img.shields.io/badge/License-AGPL--3.0-9cf)

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 install` in the main directory.
4. Run `npm install` in the client directory.
5. Run `npm build` in the client directory.
6. Run `npm start` in the main directory
7. App will run on localhost:5000
Note: pm2 or/and nginx may be used to run this app for production
-												Make README look nicer
											
										
										
											2023-03-12 14:08:35 +00:00
+								![Logo skrytki](skrytka-small.png)
-												Added README.md

											
										
										
											2023-02-27 15:56:13 +00:00
+								# skrytka.app
-												Make README look nicer
											
										
										
											2023-03-12 14:08:35 +00:00
+								![Badge z licencją AGPL-3.0](https://img.shields.io/badge/License-AGPL--3.0-9cf)
-												Added README.md

											
										
										
											2023-02-27 15:56:13 +00:00
+								To start this application you need to:
 . 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.
 . 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.
-												Updated README instructions

											
										
										
											2023-02-28 19:11:59 +00:00
+. Run `npm install` in the main directory.
 . Run `npm install` in the client directory.
 . Run `npm build` in the client directory.
 . Run `npm start` in the main directory
 . App will run on localhost:5000
-												Changed the way app is run

Now Express serves React client/build directory as static files.
All unmatched requests are answered with index.html file.

											
										
										
											2023-02-28 18:18:48 +00:00
+								Note: pm2 or/and nginx may be used to run this app for production