Skip to content

smswithoutborders/relaysms-homepage

Repository files navigation

RelaySMS

Welcome to the RelaySMS project homepage!

This project was crafted with React for a seamless development experience.

Getting Started

To get started, navigate to the project directory and execute the following commands:

yarn install
yarn start

This will launch the application in development mode. You can then access it in your browser at http://localhost:3000. The page will automatically reload as you make changes, and any lint errors will be displayed in the console.

Contribution Guide

We welcome contributions to RelaySMS! To contribute, please follow these steps:

  1. Fork the repository to your GitHub account.
  2. Clone the forked repository to your local machine.
  3. Create a new branch for your feature or bug fix:
    git checkout -b feature-name
    Replace feature-name with a descriptive name for your feature or bug fix.
  4. Make your changes and commit them with descriptive commit messages:
    git commit -am "Brief description of changes"
  5. Push your changes to your forked repository:
    git push origin feature-name
  6. Open a pull request (PR) from your forked repository's branch to the develop branch of the main repository.

Once your PR is opened, our team will review your changes and work with you to merge them into the dev branch.

Other Packages Used

In addition to React, we utilized the following packages to enhance functionality:

  • MUI
  • React Icons

Feel free to explore and contribute to make RelaySMS even better!