Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: allow Vitest as alternative testing framework for eCommerce task #1623

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions epam/async-race.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,14 @@
Below is a description of the test task. Please read it carefully. The ability to follow the requirements is important to us.
You should complete the task before proceeding to the recruiter's interview and subsequent technical interview.
During the technical interview, the interviewer may discuss your solution.
To successfuly complete the task you ***MUST*** follow the requirements carefully.
To successfuly complete the task you **_MUST_** follow the requirements carefully.

### 🚧🚧🚧 Important Notes 🚧🚧🚧
* You ***MUST*** deploy your solution (frontend only). There are many free services like GitHub Pages, Netlify, Vercel, Cloudflare Pages, etc.
* You ***MUST*** provide a link to the deployed solution (frontend only) in the README.md file. Interviewer will have its own running backend.
* You ***MUST*** include a checklist in the README.md file. And estimate your score.
* The deadline for submitting your solution is 3 weeks after the task is assigned. If you have submitted, but the assignment has not yet been verified, you may continue development.

- You **_MUST_** deploy your solution (frontend only). There are many free services like GitHub Pages, Netlify, Vercel, Cloudflare Pages, etc.
- You **_MUST_** provide a link to the deployed solution (frontend only) in the README.md file. Interviewer will have its own running backend.
- You **_MUST_** include a checklist in the README.md file. And estimate your score.
- The deadline for submitting your solution is 3 weeks after the task is assigned. If you have submitted, but the assignment has not yet been verified, you may continue development.

#### 🛑 IF YOU FAIL ANY OF THE ABOVE, THE INTERVIEWER IS ENTITLED TO REJECT YOUR ASSIGNMENT. 🛑

Expand Down
2 changes: 1 addition & 1 deletion tasks/eCommerce-Application/Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ However, there are some constraints on the technology stack:

### [Sprint 1 - Project Setup and CommerceTools Integration](./Sprints/Sprint%231.md) 🚀🔧

In the first sprint, the team will lay down the project's foundation. This includes setting up the repository, organizing the task board, integrating with CommerceTools to establish the API client, and configuring the development environment. Key technologies used in this sprint include TypeScript, ESLint, Prettier, Husky, and Jest for testing.
In the first sprint, the team will lay down the project's foundation. This includes setting up the repository, organizing the task board, integrating with CommerceTools to establish the API client, and configuring the development environment. Key technologies used in this sprint include TypeScript, ESLint, Prettier, Husky, and Jest or Vitest for testing.

### [Sprint 2 - Login, Registration, and Main Pages Implementation](./Sprints/Sprint%232.md) 🔐🖥️

Expand Down
9 changes: 5 additions & 4 deletions tasks/eCommerce-Application/Sprints/Sprint#1.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Sprint 1: Repository Setup, Project Management, CommerceTools Integration, and Development Environment Configuration (150 points) 😊

In the first sprint, the team will focus on setting up the project repository, establishing effective project management using a task board, integrating with CommerceTools to create the project and API client, and configuring the development environment with a bundler, TypeScript, ESLint, Prettier, Husky, and Jest for testing. 😎 The mentor will evaluate the team's progress and assign points based on achieving specific goals and milestones.
In the first sprint, the team will focus on setting up the project repository, establishing effective project management using a task board, integrating with CommerceTools to create the project and API client, and configuring the development environment with a bundler, TypeScript, ESLint, Prettier, Husky, and Jest or Vitest for testing. 😎 The mentor will evaluate the team's progress and assign points based on achieving specific goals and milestones.

### Working with the Repository 📁

Expand Down Expand Up @@ -36,20 +36,20 @@ In the first sprint, the team will focus on setting up the project repository, e
- **(5 points)** Set up ESLint to enforce consistent coding styles and identify potential issues in the codebase. [RSS-ECOMM-1_10](./Sprint1/RSS-ECOMM-1_10.md) 📏
- **(5 points)** Configure Prettier to automatically format code, ensuring a consistent and readable code style. [RSS-ECOMM-1_11](./Sprint1/RSS-ECOMM-1_11.md) ✨
- **(8 points)** Initialize Husky to manage Git hooks, automating tasks such as code formatting and linting checks during the commit process. [RSS-ECOMM-1_12](./Sprint1/RSS-ECOMM-1_12.md) 🐕
- **(10 points)** Install and configure Jest as the testing framework for the project, enabling comprehensive testing of code functionality. [RSS-ECOMM-1_13](./Sprint1/RSS-ECOMM-1_13.md) 🧪
- **(10 points)** Install and configure Jest or Vitest as the testing framework for the project, enabling comprehensive testing of code functionality. [RSS-ECOMM-1_13](./Sprint1/RSS-ECOMM-1_13.md) 🧪

Note: In this sprint, we will also integrate a front-end framework (e.g., React, Angular, Vue) to facilitate efficient and organized development of the user interface, but it will not be part of the evaluation criteria for the sprint. 🌐

### 5. Development Scripts (15 points) 🖊️

- **(5 points)** Create a script for running ESLint across the codebase, enabling quick and efficient identification of coding style issues and potential errors. [RSS-ECOMM-1_14](./Sprint1/RSS-ECOMM-1_14.md) 🐞
- **(5 points)** Create a script for running Prettier across the codebase, simplifying code formatting and ensuring uniform code style. [RSS-ECOMM-1_15](./Sprint1/RSS-ECOMM-1_15.md) 🎨
- **(5 points)** Create a script for running Jest tests, streamlining the process of executing tests and generating reports on test outcomes. [RSS-ECOMM-1_16](./Sprint1/RSS-ECOMM-1_16.md) 🧾
- **(5 points)** Create a script for running Jest or Vitest tests, streamlining the process of executing tests and generating reports on test outcomes. [RSS-ECOMM-1_16](./Sprint1/RSS-ECOMM-1_16.md) 🧾

### 6. Comprehensive README (19 points) 📝

- **(10 points)** Add a thorough README file in the repository, describing the project, its purpose, and the technology stack used. [RSS-ECOMM-1_17](./Sprint1/RSS-ECOMM-1_17.md) 📘
- **(5 points)** Clearly document all available scripts (e.g., for running ESLint, Prettier, and Jest tests) and their usage in the README file. [RSS-ECOMM-1_19](./Sprint1/RSS-ECOMM-1_19.md) 📜
- **(5 points)** Clearly document all available scripts (e.g., for running ESLint, Prettier, and Jest or Vitest tests) and their usage in the README file. [RSS-ECOMM-1_19](./Sprint1/RSS-ECOMM-1_19.md) 📜
- **(4 points)** Provide detailed instructions for setting up and running the project locally, ensuring newcomers and contributors can quickly get started. [RSS-ECOMM-1_20](./Sprint1/RSS-ECOMM-1_20.md) 🚀

#### Evaluation by the Mentor 🎓
Expand All @@ -73,6 +73,7 @@ To help the team understand the various tools and technologies used in this proj
11. [Prettier - Getting started](https://prettier.io/docs/en/index.html) 🎨
12. [Husky - Getting started](https://github.com/typicode/husky#readme) 🐕
13. [Jest - Getting started](https://jestjs.io/docs/getting-started) 🧪
14. [Vitest - Getting started](https://vitest.dev/guide/) 🧪

### Here is the final points distribution: 🎖️

Expand Down
8 changes: 4 additions & 4 deletions tasks/eCommerce-Application/Sprints/Sprint1/RSS-ECOMM-1_13.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
### Issue RSS-ECOMM-1_13: Install and configure Jest (10 points) 😄
### Issue RSS-ECOMM-1_13: Install and configure Jest or Vitest (10 points) 😄

#### Description 📝

Install and configure Jest as the testing framework for the project, enabling comprehensive testing of code functionality. 🔧👩‍💻🧪
Install and configure Jest or Vitest as the testing framework for the project, enabling comprehensive testing of code functionality. 🔧👩‍💻🧪

#### Acceptance Criteria 📚

- Jest is installed and configured as the testing framework for the project. ✔️
- The project allows for comprehensive testing of code functionality with Jest. ✔️🔬
- Jest or Vitest is installed and configured as the testing framework for the project. ✔️
- The project allows for comprehensive testing of code functionality with Jest or Vitest. ✔️🔬
6 changes: 3 additions & 3 deletions tasks/eCommerce-Application/Sprints/Sprint1/RSS-ECOMM-1_16.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
### Issue RSS-ECOMM-1_16: Create Jest test script (5 points) 📜
### Issue RSS-ECOMM-1_16: Create Jest or Vitest test script (5 points) 📜

#### Description 🗂️

Create a script for running Jest tests, streamlining the process of executing tests and generating reports on test outcomes. 🧪⚙️
Create a script for running Jest or Vitest tests, streamlining the process of executing tests and generating reports on test outcomes. 🧪⚙️

#### Acceptance Criteria 🎯

- A script for running Jest tests is created. 📄✅
- A script for running Jest or Vitest tests is created. 📄✅
- The script streamlines the process of executing tests and generating test outcome reports. 🚀📊
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

#### Description 🗂️

Document all available scripts (e.g., for running ESLint, Prettier, and Jest tests) and their usage in the README file. This will help team members and other contributors to better understand and utilize the available scripts. 🛠️👥
Document all available scripts (e.g., for running ESLint, Prettier, and Jest or Vitest tests) and their usage in the README file. This will help team members and other contributors to better understand and utilize the available scripts. 🛠️👥

#### Acceptance Criteria 🎯

Expand Down
Loading