README.md

Welcome to password-generator-web 👋

🚧 password-generator-web in production... 🚧

Generate good customizable passwords

Screenshots

🔖 Table Of Contents

• 🤔 How To Use
• 🚀 Technologies
• 🌱 Minimal Requirements
• 🎊 Features
  • 🎇 Finished
  • 🎆 Pendent
• 💡 How To Contribute
• 🤗 Contributors
• 👤 Author
• 🔏 License

---

🤔 How To Use

Using node

Install Dependencies

npm install

or,

yarn

Run Aplication

npm start

or,

yarn start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

Run tests

npm run cypress-open

or,

yarn cypress-open

Using docker

Create Containers

sh ./scripts/docker-compose-setup.sh

Run Aplication

sh ./scripts/start-server.sh

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

Run tests

sh ./scripts/run-tests.sh

Back To The Top

---

🚀 Technologies

• React
• Cypress
• Docker

Back To The Top

---

🌱 Minimal Requirements

• NodeJS
• NPM/Yarn

Back To The Top

---

🎊 Features

🎇 Finished

• Generate pronounceable passwords

• Show password-strength

🎆 Pendent

Back To The Top

---

💡 How To Contribute

• Make a fork of this repository
• Clone to you machine and entry on respective paste
• Create a branch with your resource: git checkout -b my-feature
• Commit your changes: git commit -m 'feat: My new feature'
• Push your branch: git push origin my-feature
• A green button will appear at the beginning of this repository
• Click to open and fill in the pull request information

Contributions, issues and features requests are welcome!
📮 Submit PRs to help solve issues or add features
🐛 Find and report issues
🌟 Star the project

Check out the contributing page to see the best places to file issues, start discussions and begin contributing.

Back To The Top

---

🤗 Contributors

Back To The Top

---

👤 Author

🤓 password-generator passgenerator.org@gmail.com

• Github: @password-generator

Back To The Top

---

🔏 License

Copyright © 2020 password-generator passgenerator.org@gmail.com

This project is licensed by MIT License.

Back To The Top

---

This README was generated with 💟 by readme-template-generator