An open API service indexing awesome lists of open source software.

https://github.com/valentyna88/phonebook-app


https://github.com/valentyna88/phonebook-app

authentication react-router reactjs redux redux-toolkit

Last synced: 3 months ago
JSON representation

Awesome Lists containing this project

README

          

# Phonebook App

## Description

Phonebook App is a simple React application that allows users to add, remove,
and search for contacts. It is designed to help users organize and manage their
contact list efficiently.

## Features

- Add new contacts with a name and phone number
- Remove existing contacts
- Search for contacts by name
- Responsive design for mobile and desktop devices

## Technologies Used

- React.js
- CSS Modules for styling

## Installation and Setup

1. Clone the repository:

```bash
git clone https://github.com/valentyna88/phonebook-app.git
```

2. Navigate to the project directory:

```bash
cd phonebook-app
```

3. Install dependencies:

```bash
npm install
```

4. Start the application:

```bash
npm start
```

The app will be available at http://localhost:3000.

## Usage

- Open the application in your browser.
- Add a new contact by entering the name and phone number, then click "Add".
- Search for a contact using the search bar.
- Remove a contact by clicking the "Delete" button next to the contact's name.

## Folder Structure

```css
src/
├── assets/
├── components/
│ ├── AppBar/
│ ├── AuthNav/
│ ├── Contact/
│ ├── Loader/
│ └── SharedComponents/
├── pages/
│ ├── HomePage/
│ ├── LoginPage/
│ └── RegistrationPage/
├── redux/
├── utils/
├── App.jsx
└── main.jsx
```

## Contributing

Contributions are welcome! If you'd like to contribute to this project:

1. Fork the repository.
2. Create a new branch:

```bash
git checkout -b feature-name
```

3. Make your changes.
4. Commit your changes:

```bash
git commit -m 'Add feature'
```

5. Push to the branch:

```bash
git push origin feature-name
```

6. Open a Pull Request.

## License

This project is open-source and available under the MIT License.