Breakify

The Breakify project aims to provide a user-friendly interface where users can input words into text fields. When a word is entered, the application checks if the first two letters of each word match any element symbol in the periodic table. If there's a match, the matched portion of the word is highlighted.

Getting Started

1. Prerequisites: Node v18 + installed on your machine to run the development server:
2. Running:

npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev

You can use :

npm run lint

To check issues or warnings.

Open http://localhost:3000 with your browser to see the result.

Using Docker

1. Prerequisites:

   • Docker installed on your machine

2. Clone the repository:

   git clone https://github.com/petrious/react-challenge.git

3. Build the Docker image:

   docker-compose up --build

4. Access the application at http://localhost:3000

Contributing

If you'd like to contribute to this project, follow these steps:

1. Fork the project
2. Create a new branch (git checkout -b feature/new-feature)
3. Commit your changes (git commit -am 'Add a new feature')
4. Push to the branch (git push origin feature/new-feature)
5. Open a Pull Request

License

This project is licensed under the Workana.