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

[asuponev]

---

Pull Request for mentor review and evaluation, please do not merge.

---

1. Task: link
2. Screenshot:
   
   
3. Deploy: link (not required for this sprint, attached is a link to the github repository)
4. Done 07.08.2023 / deadline 07.08.2023
5. Score: 150 / 150

Mentor Evaluation Criteria (150/150):

• Repository Setup (29 points):
  • (10 points) Create a GitHub repository for the project, complete with a README file, .gitignore, and necessary dependencies.
  • (10 points) Set up a clear and organized folder structure within the repository, ensuring a maintainable and scalable codebase.
  • (4 points) Invite all team members and the mentor as collaborators, ensuring everyone has access to contribute to the repository.
  • (5 points) Create a pull request template with a clear structure for describing proposed changes and the rationale behind them.
• Task Board Setup (14 points):
  • (6 points) 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).
  • (5 points) Break down project tasks into smaller, manageable subtasks and assign them to team members, ensuring a clear delegation of responsibilities.
  • (3 points) Share the task board with the team members and the mentor, ensuring everyone can track progress and update the status of their tasks.
• CommerceTools Project and API Client Setup (30 points):
  • (15 points) Create the project in CommerceTools, setting up the currencies, languages, and other configurations in the Merchant Center.
  • (15 points) Create the API client for CommerceTools, enabling access to the platform's APIs and managing permissions and scopes required for the project.
• Development Environment Configuration (43 points):
  • (10 points) Set up and configure a bundler (e.g., Webpack, Vite, Parcel, or other) for the project, supporting both development and production build modes.
  • (5 points) Configure TypeScript to enforce strong typing and improve code quality throughout the project.
  • (5 points) Set up ESLint to enforce consistent coding styles and identify potential issues in the codebase.
  • (5 points) Configure Prettier to automatically format code, ensuring a consistent and readable code style.
  • (8 points) Initialize Husky to manage Git hooks, automating tasks such as code formatting and linting checks during the commit process.
  • (10 points) Install and configure Jest as the testing framework for the project, enabling comprehensive testing of code functionality.
• 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.
  • (5 points) Create a script for running Prettier across the codebase, simplifying code formatting and ensuring uniform code style.
  • (5 points) Create a script for running Jest tests, streamlining the process of executing tests and generating reports on test outcomes.
• Comprehensive README (19 points):
  • (10 points) Add a thorough README file in the repository, describing the project, its purpose, and the technology stack used.
  • (5 points) Clearly document all available scripts (e.g., for running ESLint, Prettier, and Jest tests) and their usage in the README file.
  • (4 points) Provide detailed instructions for setting up and running the project locally, ensuring newcomers and contributors can quickly get started.