gWordle

gWordle

Wordle BOT & Helper

https://gwordle.gigini.it

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

🔼 top

About The Project

Play Wordle against the 🤖 BOT, read words list or use gWordle Helper to help you solve your daily Wordle attempt.

🔼 top

Built With

• 
• 
• 
• 
• 

🔼 top

Getting Started

To get a local copy up and running follow these example steps.
(These are general guidelines that require some basic knowledge of the Linux system, the MySQL database, and the PHP CodeIgniter framework)

🔼 top

Prerequisites

A LAMP stack (Linux-Apache-MySQL-PHP).

🔼 top

Installation

1. Clone the repo (main branch)

   git clone https://github.com/gcangini/gwordle

2. add CodeIgnitier4 framework missing files

   cd gwordle
   composer install
   chmod -R ug+w writable

3. create and populate database (with SQL scripts)
4. create .env file to set app.baseURL and database connection parameters
5. Change git remote url to avoid accidental pushes to base project

   git remote set-url origin https://github.com/<YOUR_USER>/<YOUR_PROJECT>
   git remote -v # confirm the changes

6. configure sitemap.xml with your own URL
7. setup the daily update of past used words with a call to /five-forks (i.e. with crontab wget)
8. Enjoy :-)

(🔼 top)

Roadmap

• restricted area with access via Google login for users participating in the monthly private Wordle championship

See the open issues for a full list of proposed features (and known issues).

🔼 top

Contributing

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

🔼 top

License

Distributed under the Creative Commons CC0 1.0 Universal license.

🔼 top

Contact

Gianlica Cangini - gcangini@hotmail.com

Project Link: https://github.com/gcangini/gwordle

Online web app: https://gwordle.gigini.it

🔼 top

Acknowledgments

• my friends who beta-tested the app (Cea, Linda, Fausto)
• FiveForks Wordle page that provide daily update of Past Used Wordle Words

🔼 top