SupportModalApp

Welcome to the SupportModalApp project! This repository houses a small web application designed to enhance user experience with interactive support actions.

The app is designed to be scalable, allowing it to handle a growing number of users efficiently. It's made available through a JavaScript drop-in library, please review the repository for more detailed documentation of how to utilize it.

Project Setup

Get started by cloning our project

git clone git@github.com:diggsweden/SupportModalApp.git

Install the necessary dependencies:

npm install

Development

For development purposes, you can compile and hot-reload with:

npm run dev

Production

To compile and minify for production, run:

npm run build

Testing

Our project embraces rigorous testing to ensure quality and reliability.

Unit Tests with Vitest

Run unit tests using:

npm run test:unit

End-to-End Tests with Cypress

For end-to-end testing, use the following commands:

Against the Vite development server (Faster):

npm run test:e2e:dev

Against the production build (Recommended before deployment):

npm run build
npm run test:e2e

Linting

Maintain code quality and consistency with ESLint:

npm run lint

Docker Integration

The SupportModalApp is Docker-ready for easy deployment and testing.

Build the Docker Image

Build a Docker image named digg-support-modal-app-image:

make build-supportmodalapp

Run and Manage the Docker Container

To run, stop, or remove the Docker container, use the respective commands:

Run:

make run-supportmodalapp

Stop:

make stop

Remove container:

make rm

Remove image:

make rmi

Contributing

Contributions to the UserFeedbackApp are welcome and encouraged! To contribute, follow these steps:

1. Fork the repository to your GitHub account.
2. Create a new branch based on the main branch for your changes:

   git checkout -b feature/your-feature-name
   

3. Make your desired changes and commit them with descriptive commit messages.
4. Push the changes to your forked repository.
5. Submit a pull request from your branch to the main branch of this repository.
6. Your pull request will be reviewed, and once approved, it will be merged.

Please ensure to follow the Code of Conduct when contributing.

License

This project is licensed under the MIT License. Feel free to use, modify, and distribute the code for personal or commercial projects.