🔢 XKCD Password Generator 🔠

XKCD Password Generator with multilingual support, easy typing, and number substitutions options.

Table of Content 📘

• 🔢 XKCD Password Generator 🔠
  • Table of Content 📘
  • Features ✨ 😎
  • Demo and Screenshots 📷 📹
  • Usage 🎮
    • Cloning and Virtual Environment
    • Running the Web App
  • Tools 👓
  • Current Web App Hierarchy 💪
  • Future Plans 🔜
  • Contributing 🔥
  • Collaborators & Contributors 🕺 💃
  • Inspiration 📓
  • License 📚

Features ✨ 😎

Currently, XKCD Password Generator supports the following:

• Generating Passwords - 10 Per Request
  • Four Words per Password
• Minimum Password Length
• Maximum Password Length
• Minimum Word Length
• Maximum Word Length
• Eleven Languages

📷 Demo and Screenshots 📹

XKCD Password Generator	XKCD Password Generator

Usage 🎮

This web app is written in Python 3.6 using Flask Web Framework. Frontend uses Bootstrap Framework.

Cloning and Virtual Environment

Make sure you have Python 3.6 installed.

• git clone https://github.com/Ahmad-Magdy-Osman/XKCDPasswordGenerator.git
• cd XKCDPasswordGenerator
• python3.6 -m venv venv
• source venv/bin/active
• You might want to update pip using python-3.6 -m pip --upgrade pip
• Install requirements with python3.6 -m pip install -r requirements.txt

Running the Web App

• Run the Web App using python3.6 xkcd.py
• Visit http://127.0.0.1:5000/

Tools 👓

Programming Languages, Frameworks, Libraries, APIs, Databases, and Data Formats.

• Python 3
  • Flask
    • Flask-WTF
    • Flask-Bootstrap
• HTML & CSS
  • Bootstrap Framework

Current Web App Hierarchy 💪

• Main Page
  • Passwords Generation Options
• Generated Passwords Page
  • Leads back to Main Page
• More to come...

Future Plans 🔜

Some of the features and functions that would be appropriate for XKCD Password Generator. Please feel free to pick any of them and start working on improving it as a contributor.

• General
  • Mobile Responsiveness
  • Project Structure and Cleaning
• Features
  • User Session
    • Removing Words if Generated Before
  • Regenerate on Generated page
  • Remember User Preferences
• Style/Design
  • Fonts
  • Favico
  • GitHub Corner
  • Divs & Footer
• Marketing
  • SEO
• Read Me
  • Add Collaborates and Contributors

Contributing 🔥

1. 🍝 Fork this repo!
2. Clone and cd into it
3. Setup your virtual environment.
4. Create your feature branch: git checkout -b my-new-feature
5. Commit your changes: git commit -m 'Add some feature'
6. Push to the branch: git push origin my-new-feature
7. Submit a pull request 👍

🕺 Collaborators & Contributors 💃

_{Ahmad M. Osman}

Inspiration 📓

You will fail.

You will mess up.

You'll do poorly on assignments and tests.

Your side projects will not work.

Your code will be sloppy and incomplete.

You will bomb job interviews.

Your PR's will be rejected.

And because you fail, you will succeed.

Don't be afraid to fail, don't let it destroy your self-confidence, don't let it define you. Instead, do everything you can to learn from that failure and take that new knowledge into the next piece of work.

Indeed, failure is the only path to success.

    ― Stranger on the Internet.

License 📚

XKCD Password Generator is an open source project under MIT license.