From b6ce27cdfb7a71f9f0d364600aff0898e23c8203 Mon Sep 17 00:00:00 2001 From: Wroclaw Date: Sun, 11 Jun 2023 19:12:25 +0200 Subject: [PATCH] add README.md --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..c1f2342 --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +# WorkshopTasker + +Allows for managing order tasks and inported products for a small work shop. + +*A college database project* + +# Running + +The project was tested with the nodejs version v18.16.0. It may not work with newer versions of nodejs. + +Dev dependencies are required. `npm install -D` + +Project uses Oracle MySQL as a database store. It uses environment variables for the connection settigns. All provided variables below are required. + +| Environment variable | Description | +|----------------------|-------------------| +| `DB_HOST` | Database host | +| `DB_PORT` | Database port | +| `DB_USER` | Database user | +| `DB_PASSWORD` | Database password | +| `DB_SCHEMA` | Database schema | + +After setting variables, you can run the project using `npx nuxi dev` or `npx nuxi preview`