File tree Expand file tree Collapse file tree 2 files changed +32
-10
lines changed
Expand file tree Collapse file tree 2 files changed +32
-10
lines changed Original file line number Diff line number Diff line change @@ -45,11 +45,40 @@ This project uses Supertest to test the API endpoints. Supertest is a popular li
4545
4646## Getting Started
4747
48- ## Project Structure
48+ ## Prerequisites
49+ This guide will help you set up the project and run the tests locally.
50+ - Node.js (v18.x or higher recommended)
51+ - npm (comes with Node.js)
4952
50- ### Prerequisites
53+ ## Setup Instructions
54+ 1 . Clone the repository
55+ ```
56+ git clone https://github.com/monikakonieczna/api-testing-framework-typescript.git
57+ cd api-testing-framework-typescript
58+ ```
59+ 2 . Install dependencies
60+ ```
61+ npm install
62+ ```
63+ 3 . Run tests
64+ To run all tests:
65+ ```
66+ npm test
67+ ```
68+ To run specific group of tests, like sanity tests:
69+ ```
70+ npm run test:sanity
71+ ```
5172
52- - Node.js
73+ ## Project Structure
74+ - .github/workflows/: GitHub Actions workflow configurations
75+ - src/helpers/: Helper functions and utilities used throughout the project.
76+ - src/interfaces/: TypeScript interfaces for typing and structure definitions.
77+ - src/test_data/: Sample data for tests.
78+ - src/tests/: Contains all test files.
79+ - setupTests.ts: A setup file for Jest, which runs before each test to load environment variables from .env file.
80+ - jest.config.ts: Jest configuration file for test runner settings.
81+ - tsconfig.json: TypeScript configuration file that defines how the TypeScript compiler should behave.
5382
5483## Third-Party Libraries
5584### Jest Runner Groups
Load Diff This file was deleted.
You can’t perform that action at this time.
0 commit comments