Password Generator

This application is a simple password generator application
Explore the docs »

View Demo · 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

About The Project

(back to top)

Built With

(back to top)

Getting Started

To get started with this project, you can use yarn.

npm install --global yarn

Installation

To run the application in local, you can follow this steps.

1. Clone the repo

   git clone https://github.com/fernan-x/password-generator.git

2. Install NPM packages

   yarn

3. Run the application in development mode

   yarn dev

To launch unit tests, you can run the test command.

yarn test

To build the application, you can run the build command.

yarn build

(back to top)

Usage

This interface aims to help you generating strong password. Choose your password length (20 characters max), select if you want to include uppercase, numbers or symbols on your password and generate it.

After generation, you will see your generated password which can be copied with Copy Button.

(back to top)

Roadmap

There are no functionnalities on the roadmap for now. Do not hesitate to propose any features you want to see on the application.

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

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

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

(back to top)

License

Distributed under the MIT License. See LICENSE.md for more information.

(back to top)

Contact

Fabien FERNANDES ALVES - [email protected]

Project Link: https://github.com/fernan-x/password-generator

(back to top)