Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Vanessa-Kris authored May 1, 2024
1 parent a9b8ef0 commit 1d9a8f5
Showing 1 changed file with 44 additions and 9 deletions.
53 changes: 44 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,50 @@
# Getting Started
# RelaySMS

This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
Welcome to the RelaySMS project homepage!

In the project directory, you can run:
This project was crafted with [React](https://github.com/facebook/create-react-app) for a seamless development experience.

### `yarn install`
## Getting Started

### `yarn start`
To get started, navigate to the project directory and execute the following commands:

Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
```bash
yarn install
```
```bash
yarn start
```

The page will reload when you make changes.\
You may also see any lint errors in the console.
This will launch the application in development mode. You can then access it in your browser at [http://localhost:3000](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:
```bash
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:
```bash
git commit -am "Brief description of changes"
```
5. Push your changes to your forked repository:
```bash
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!

0 comments on commit 1d9a8f5

Please sign in to comment.