WordSpark presents an immersive word puzzle gaming experience, reminiscent of the beloved Wordle game, but with its own unique flair. This engaging project offers players an addictive journey into the realm of word decryption and logical deduction. The objective is clear: unveil the concealed five-letter word within a limited set of attempts.
You can access the live version of WordSpark by visiting: WordSpark Live
- React
- TypeScript
- CSS Modules
- Vite: Used for development and bundling of the application.
- StyleLint: Used to ensure code consistency and adherence to standards.
- ESLint: Used with the AirBNB React standards to maintain code quality.
- Prettier: Used as a code formatter to ensure consistent code style.
- TSDoc: Used for documentig project.
- GitHub Pages: Used for hosting the WordSpark application.
- GitHub Actions: Utilized as a simple CI/CD pipeline for automated deployments.
- Husky: Utilized as a pre-commit hooks to ensure code quality.
- SWR: React Hooks for Data Fetching.
The following APIs are used in the WordSpark application:
- Wordle Answers Solutions: Today's answer.
To run the WordSpark application locally, follow these steps:
- Clone this repository:
git clone https://github.com/splawskip/WordSpark.git. - Navigate to the project directory:
cd WordSpark. - Install the dependencies:
npm install. - Build the application:
npm run buildor usenpm run devto start Vite server. - Open the
index.htmlfile in your preferred web browser or open url generated by Vite.
The codebase of WordSpark is very well documented using JSDoc comments. If you would like to generate documentation, you can do so by running the following command after installing the project: npm run jsdoc.
This project is licensed under the MIT License. See the LICENSE file for more information.
- Przemysław Spławski 👉 @splawskip
For any inquiries or support, please contact me by choosing some possible contact option available on my profile.