Skip to content

README.md

Latest commit

 

History

History
77 lines (48 loc) · 1.4 KB

README.md

File metadata and controls

77 lines (48 loc) · 1.4 KB

HelloKitchen banner

HelloKitchen - Back-End

Welcome to the HelloKitchen Back-End repository! This project powers the server-side functionality of the HelloKitchen platform.

🛠️ Project Setup

To get started, install the required dependencies:

$ npm install

⚙️ Environment Configuration

Create a .env file at the root of the project with the following variables:

SALT_HASH = [Salt hash used for login]
DB_URL_LOCAL = [Database URL for local development]
DB_URL = [Database URL for production]

🚀 Running the Project

You can compile and run the project using the following commands:

Development Mode

$ npm run start

Watch Mode (Auto-reload)

$ npm run start:dev

Production Mode

$ npm run start:prod

🧪 Running Tests

Ensure code quality with the available tests:

Unit Tests

$ npm run test

End-to-End (E2E) Tests

$ npm run test:e2e

Test Coverage

$ npm run test:cov

📄 Documentation

Comprehensive documentation for the project can be found in the Wiki section of the GitHub repository.

🤝 Contribution Guidelines

Currently, this project does not accept external contributions. Feel free to explore the codebase, but contribution via pull requests is restricted.