This project consists of a Chrome extension and a server, both containerized using Docker, and bundled using Webpack.
To install the Chrome extension, follow these steps:
- Clone the repository:
git clone https://github.com/AdamSchmidty/Fluentify.git - Install the dependencies:
npm install - Build the extension:
npm run build:extension - Open Google Chrome and navigate to
chrome://extensions - Enable Developer mode by toggling the switch in the top right corner
- Click on "Load unpacked" and select the
distfolder in the project directory
To run the server, follow these steps:
- Build the server Docker image:
docker build -t server . - Run the server container:
docker run -p 8080:8080 server
Once the Chrome extension is installed and the server is running, you can use the extension to interact with the server. The extension provides a user interface for sending requests to the server and displaying the responses.
Contributions are welcome! To contribute to this project, please follow these steps:
- Fork the repository
- Create a new branch:
git checkout -b my-new-feature - Make your changes and commit them:
git commit -am 'Add some feature' - Push to the branch:
git push origin my-new-feature - Submit a pull request
- To start the docker compose:
docker-compose up - To rebuild docker compose
docker-compose up --build --force-recreate
This project is licensed under the MIT License - see the LICENSE file for details.