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

README: Precise a description of running of a project.
All checks were successful
Build dev / build (push) Successful in 1m0s
Details

Browse source
This commit is contained in:
Wroclaw 2023-11-09 04:43:54 +01:00
parent 5602c22861
commit ccbbfd1d3b
1 changed files with 16 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -6,9 +6,7 @@ Allows for managing order tasks and imported products for a small workshop.
# 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`
The project was tested with the nodejs version v18.17.1. It may not work with versions higher than 18 of nodejs.
Project uses Oracle MySQL as a database store. It uses environment variables for the connection settings. All provided variables below are required.
@ -16,4 +14,18 @@ Project uses Oracle MySQL as a database store. It uses environment variables for
|----------------------|-------------------|
| `DB_URL` | Database url, see [this](https://www.prisma.io/docs/concepts/database-connectors/mysql#connection-url) |
After setting variables, you can run the project using `npx nuxi dev` or `npx nuxi preview`.
## From Repository
Dev dependencies are required. `npm install -D`.
After setting variables, you can run the project using `npx nuxi dev`.
You can also setup variables by placing .env file in the root of the repository.
When using nix, you can use `nix-shell` to get prisma engines installed in your environment.
## From Actions
You can download build from [repository actions](https://git.proot.pl/Wroclaw/WorkshopTasker/actions?workflow=build.yml).
You need to extract tar file.
After setting environment variables, you can launch the project using the `node server/index.mjs` command.