Sprint 1: Repository Setup, Project Management, CommerceTools Integration, and Development Environment Configuration

[Pavelvl21]

Description

Sprint 1: Repository Setup, Project Management, CommerceTools Integration, and Development Environment Configuration

Motivation

Set up a project repository, set up efficient project management with a task board, integrate with CommerceTools for project creation and an API client, and set up a development environment with builder, TypeScript, ESLint, Prettier. , Husky and Jest for testing.

Type of change

1. Repository Setup:

• Create a GitHub repository for the project, complete with a README file, .gitignore, and necessary dependencies
• Set up a clear and organized folder structure within the repository, ensuring a maintainable and scalable codebase
• Invite all team members and the mentor as collaborators, ensuring everyone has access to contribute to the repository
• Create a pull request template with a clear structure for describing proposed changes and the rationale behind them

2. Task Board Setup:

• Create a project task board using a project management tool (e.g., Trello or Jira), organizing tasks into lists or columns corresponding to their status (e.g., To Do, In Progress, Done
• Break down project tasks into smaller, manageable subtasks and assign them to team members, ensuring a clear delegation of responsibilities
• Share the task board with the team members and the mentor, ensuring everyone can track progress and update the status of their tasks

3. CommerceTools Project and API Client Setup (30 points):

• Create the project in CommerceTools, setting up the currencies, languages, and other configurations in the Merchant Center
• Create the API client for CommerceTools, enabling access to the platform's APIs and managing permissions and scopes required for the project

4. Development Environment Configuration:

• Set up and configure a bundler (e.g., Webpack, Vite, Parcel, or other) for the project, supporting both development and production build modes
• Configure TypeScript to enforce strong typing and improve code quality throughout the project
• Set up ESLint to enforce consistent coding styles and identify potential issues in the codebase
• Configure Prettier to automatically format code, ensuring a consistent and readable code style
• Initialize Husky to manage Git hooks, automating tasks such as code formatting and linting checks during the commit process
• nstall and configure Jest as the testing framework for the project, enabling comprehensive testing of code functionality

5. Development Scripts:

• Create a script for running ESLint across the codebase, enabling quick and efficient identification of coding style issues and potential errors
• Create a script for running Prettier across the codebase, simplifying code formatting and ensuring uniform code style
• Create a script for running Jest tests, streamlining the process of executing tests and generating reports on test outcomes

6. Comprehensive README:

• Add a thorough README file in the repository, describing the project, its purpose, and the technology stack used
• Clearly document all available scripts (e.g., for running ESLint, Prettier, and Jest tests) and their usage in the README file
• Provide detailed instructions for setting up and running the project locally, ensuring newcomers and contributors can quickly get started

Checklist:

• My code follows the style guidelines of this project
• I have performed a self-review of my code
• I have commented my code in hard-to-understand areas
• My changes generate no new warnings