🚒 App which helps firefighters to learn equipment placement in fire trucks, because every second matters
Go to file
2023-03-18 09:03:08 +01:00
client deletion of redundant files, semicolon and small fixes 2023-03-16 19:06:03 +01:00
media/images Created media directory and hosting it as static 2023-02-28 19:54:33 +01:00
migrations Replaced SQL scripts with Knex migrations 2023-03-18 09:00:37 +01:00
.env.example Moved cookie secret to env file 2023-03-14 17:36:51 +01:00
.gitignore fix env 2023-03-11 21:18:50 +01:00
app.js Moved cookie secret to env file 2023-03-14 17:36:51 +01:00
knexfile.js Replaced SQL scripts with Knex migrations 2023-03-18 09:00:37 +01:00
LICENSE.txt Create LICENSE.txt 2023-02-26 15:51:02 +01:00
package-lock.json Replaced SQL scripts with Knex migrations 2023-03-18 09:00:37 +01:00
package.json Replaced SQL scripts with Knex migrations 2023-03-18 09:00:37 +01:00
README.md Updated database instructions 2023-03-18 09:03:08 +01:00
skrytka-small.png Added small skrytka logo 2023-03-12 15:00:44 +01:00

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, 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 SQL migrations. To do that you should have knex installed globally (npm install knex -g) and then execute knex migrate:latest in the root 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