Antique Boutique E-commerce Project

Hi there !👋

Welcome to our final project app!! We are a team of RSSchool students and we are making an e-commerce project for a vintage items shop.

This project is intended for non-commercial use. Our only benefit is the acquisition of new knowledge and honing of technological skills.🚸.

If you have any questions, please do not hesitate to contact us at .

The project is built using:

Table of Contents

1. 🖥️ Installation
2. 🤖 Scripts
3. 🐶 About Husky
4. 📑 About Commitlint
5. ⚙️ Testing
6. ✍️ Contributing

Installation

Before you start, ensure you have Node.js installed.

1. Clone the repository link.

   To clone the repository you can use the following command

   git clone https://github.com/IggyPope/antique-boutique.git

   or the interface of your IDE.

2. Install dependencies

   Make sure you are in the develop branch

   git checkout develop
   npm install

3. Initialize husky

   npm run prepare

Scripts

After cloning the repository and installing the dependencies you can run scripts.

1. Run development server

   To launch the development server, open your terminal and write the following command

   npm run dev

   The application will start on the indicated address. Copy and paste it into the address bar of your browser.

2. To build project

   To build the project you need to run the following command

   npm run build

   It will create a dist folder in your local repository and you will be able to deploy the bundled project

3. To preview built project

   To preview the builded project you need to run the following command

   npm run preview

   The bundle will start on the indicated address. Copy and paste it into the address bar of your browser.

4. Run EsLint to find and fix mistakes in code

   If you want to check for errors in the code, you can run the following command

   npm run lint:check

   After executing this command you will see all the errors in the code of all the files with .ts and .tsx extensions

   If errors are detected, some of them can be fixed automatically by running the following command

   npm run lint:fix

5. Run Prettier to format code

   If you want to format the code according to Prettier rules, you can run the following command

   npm run format:fix

   It will format the code in all the files.

6. Run StyleLint to find and fix mistakes in style files with .scss extension

   If you want to check for errors in the .scss files, you can run the following command

   npm run style:check

   After executing this command you will see all the errors in the code of all the files with .scss extension

   If errors are detected, some of them can be fixed automatically by running the following command

   npm run style:fix

About Husky

In our project we use Husky and lint-staged package. It means that when you try to commit changes the following scripts will be executed automatically for all staged files:

npm run lint:fix
npm run format:fix
npm run style:fix

and if any mistakes are detected after executing these scripts, you'll have to fix them manually before you can commit.

About Commitlint

In our project we use Commitlint. All commit messages will be validated according to the Conventional Commits specification.

Testing

This project uses Vitest for testing

You can run existing tests or create custom tests and execute it by running the following command

npm run test

Contributing

We welcome contributions from the community Your ideas, bug reports, feature requests, and pull requests are highly appreciated. Before you start contributing, please take a moment to review the following guidelines:

Code Contributions

• Fork the Repository: Fork this repository to your own GitHub account.
• Create a Branch: Create a new branch for your contribution. It's a good practice to name your branch descriptively based on the issue you're addressing.
• Commit Changes: Make your changes in the branch. Ensure your commit messages are clear and descriptive.
• Pull Request: Submit a pull request to the original repository. Provide a detailed description of the changes made and why they were necessary.

Reporting Issues

If you encounter a bug or have a feature request, please report it using the issue tracker. Include as much detail as possible to help us understand and resolve the issue efficiently.

Testing your contributions

Please ensure that all tests pass after making changes. If you add new functionality, consider adding corresponding tests to cover the new code.

Code Style

We follow a specific coding style and use tools like ESLint and Prettier to enforce it. Please make sure your code adheres to the existing style.

Communication

Feel free to reach out if you have questions or need clarification on anything. We're here to help!

Thank you for your interest in contributing to Antique Boutique!