Wroclaw/WorkshopTasker
2
1
Fork 1
Code Issues Pull requests Activity Actions

add README.md

Browse source
This commit is contained in:
Wroclaw 2023-06-11 19:12:25 +02:00
parent 4e67cc4e19
commit b6ce27cdfb
1 changed files with 23 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
README.md Normal file
View file

@ -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`