Skip to content

readme.md

Latest commit

 

History

History
67 lines (46 loc) · 1.9 KB

readme.md

File metadata and controls

67 lines (46 loc) · 1.9 KB
Raw

Password Generator

This project is a web-based password generator built with React, TypeScript, and Tailwind CSS. It allows users to generate secure passwords with customizable options.

Finished this project after a I forgot about it. Based on the FrontendMentor excercise. Glad I finally have a frontend-ish project to show. Also really cool it's actually kind of useful for the everyday user!

Table of Contents

Installation

  1. Clone the repository:

    git clone https://github.com/MarcelOlsen/password-generator.git
cd password-generator

  2. Install dependencies:

    npm install

Usage

To start the development server, run:

npm run dev

Open your browser and navigate to http://localhost:3000 to see the application in action.

Development

Project Structure

  • index.html: The main HTML file.
  • src/: Contains the source code.
    • main.tsx: Entry point for the React application.
    • index.css: Global styles using Tailwind CSS.
    • components/: Contains React components.
    • contexts/: Contains context providers for state management.
  • postcss.config.js: Configuration for PostCSS.
  • tailwind.config.js: Configuration for Tailwind CSS.
  • tsconfig.json: TypeScript configuration.
  • .eslintrc.cjs: ESLint configuration.

Scripts

  • npm run dev: Start the development server.
  • npm run build: Build the project for production.
  • npm run lint: Lint the source code.
  • npm run preview: Preview the production build.

Contributing

Contributions are welcome! Please open an issue or submit a pull request for any changes.

License

This project is licensed under the MIT License. See the LICENSE file for details.