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
🚒 App which helps firefighters to learn equipment placement in fire trucks, because every second matters
53 Commits 1 Branch 0 Tags 117 MiB
JavaScript 71.7%
SCSS 25.8%
HTML 1.9%
CSS 0.6%
1092ac659b
Go to file
Stachu 1092ac659b fix bug with end screen and btnCorrectAnswer
2023-03-14 21:02:22 +01:00
client fix bug with end screen and btnCorrectAnswer 2023-03-14 21:02:22 +01:00
media/images Created media directory and hosting it as static 2023-02-28 19:54:33 +01:00
.env.example Make call from the API 2023-03-06 21:58:29 +01:00
.gitignore fix env 2023-03-11 21:18:50 +01:00
app.js Removed unecessary code 2023-03-13 20:21:39 +01:00
LICENSE.txt Create LICENSE.txt 2023-02-26 15:51:02 +01:00
package-lock.json Removed unnecessary or wrong changes 2023-03-11 23:10:13 +01:00
package.json fix react-scripts 2023-03-11 21:06:22 +01:00
README.md Add caution to README 2023-03-13 20:25:16 +01:00
skrytka_create_db.sql Removed unnecessary or wrong changes 2023-03-11 23:10:13 +01:00
skrytka_create_utils.sql Removed unnecessary or wrong changes 2023-03-11 23:10:13 +01:00
skrytka-small.png Added small skrytka logo 2023-03-12 15:00:44 +01:00

README.md

Logo skrytki

skrytka.app

Badge z licencją AGPL-3.0

Be aware that this app is not stable yet and new commits may introduce breaking changes

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.
    • 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.
  4. Run npm install in the client directory.
  5. Run npm build in the client directory.
    • 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
  7. App will run on localhost:5000 Note: pm2 or/and nginx may be used to run this app for production