diff --git a/README.md b/README.md index a8709be..8fdff30 100644 --- a/README.md +++ b/README.md @@ -2,23 +2,11 @@ ## It is API that does CRUD operations on food recipes. Cyberchef has built in parser that can parse recipes from the web. -#### To work with DB properly, create config.json file in src/database/config: -``` -"db_host": "your hosting", -"db_user": "your username", -"db_database": "your db name", -"db_password": "your db pass" -``` - -#### To properly work with server create .env file in src/api +#### To properly work with server and database create .env file in root folder ``` PORT = 3000 || any other port JWT_ACCESS_SECRET = "your secret key" -``` - -#### To generate prisma client -```bash -npx prisma generate --schema=./src/database/prisma/schema.prisma +DATABASE_URL = "your connecting string" ``` #### To start parser: @@ -28,15 +16,21 @@ npx prisma generate --schema=./src/database/prisma/schema.prisma #### To start server: ```bash -/src/api/ npm run dev +npm run start ``` +#### All scripts: +* `npm run installDependencies` - install dependencies +* `npm run preinstall` - generates prisma client and install dependencies +* `npm run start:dev` - starts nest server in dev mode +* `npm run start` - Builds server and client and starts in production mode + ### Technology stack * Parser - NodeJS -* Frontend - VueJs -* Backend - Express -* Database - MySQL +* Frontend - ReactJS & Redux +* Backend - NestJS +* Database - PostgreSQL ### License