Skip to content

Jonathanthedeveloper/ussd-app

Repository files navigation

USSD Code PWA

License

Netlify Status

Overview

The USSD Code PWA is a Progressive Web Code that simplifies access to USSD codes by providing a user-friendly catalog of available codes. Users can browse through the catalog, search for specific codes, and easily copy them to their device's clipboard. This project aims to enhance the accessibility and convenience of USSD services for users.

Installation

  1. Ensure that you have Node.js installed.
  2. Clone this repository to your local machine.
  3. Navigate to the project directory in your terminal.
  4. Run the following command to install the dependencies:
    npm install

Usage

Start the development server with the following command:

npm run dev

This will launch the PWA in your default browser. Browse through the available USSD codes. Use the search functionality to find specific codes. Click on a code to copy it to your device's clipboard.

Contribution Guidelines

Contributions are welcome! To contribute to this project, follow these steps:

  • Fork the repository.
  • Create a new branch for your feature or bug fix:
git checkout -b feature/your-feature-name
  • Make your modifications and commit the changes.
  • Push your branch to your forked repository:
git push origin feature/your-feature-name
  • Open a pull request against the main branch of this repository.

Please adhere to the Code of Conduct and ensure that your contributions align with the project's goals and style guidelines.

Code Structure src/ - Contains the main source code of the PWA. public/ - Includes the public assets

License

This project is licensed under the MIT License.

Contact

For any questions or feedback, please contact the project maintainer:

Twitter: human_who_codes

Acknowledgments

The creators and contributors of React and Vite. The open-source community for their valuable resources and inspiration.