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

https://github.com/douzandeh/contact-app

A simple and responsive Contact Management App built with React.js. Features include: Adding, displaying, and deleting contacts Conditional rendering when no contacts exist Modular components for clean code (Contacts, ContactList, ContactItem, Alert) Styled using CSS Modules and keys li
https://github.com/douzandeh/contact-app

contact-app contacts css css-modules javascript modular-components react reactjs uuid

Last synced: 3 months ago
JSON representation

A simple and responsive Contact Management App built with React.js. Features include: Adding, displaying, and deleting contacts Conditional rendering when no contacts exist Modular components for clean code (Contacts, ContactList, ContactItem, Alert) Styled using CSS Modules and keys li

Awesome Lists containing this project

README

          

---

# Contact-App

A simple contact management application built with **React** and **Vite**.

## ๐Ÿš€ Quick Start

### Prerequisites

Make sure you have [Node.js](https://nodejs.org/) and [npm](https://www.npmjs.com/) installed on your system.

### Installation

1. Clone the repository:

```bash
git clone https://github.com/Douzandeh/Contact-App.git
```

2. Navigate to the project folder:

```bash
cd Contact-App
```

3. Install the dependencies:

```bash
npm install
```

### Running the App

To run the project in development mode:

```bash
npm run dev
```

Open your browser and go to `http://localhost:3000` to see the app.

## ๐Ÿ› ๏ธ Features

* Add, edit, and delete contacts
* Quick search among contacts
* Data stored in browser's Local Storage
* Simple and responsive user interface
* Built with React and Vite for fast development

## ๐Ÿ“‚ Project Structure

* `src/`: Source code

* `components/`: React components
* `App.jsx`: Main application component
* `public/`: Public files like `index.html`
* `package.json`: Dependencies and npm scripts
* `vite.config.js`: Vite configuration

## ๐Ÿงช Development & Build

* Run the app in development mode:

```bash
npm run dev
```

* Build the app for production:

```bash
npm run build
```

* Run tests (if any):

```bash
npm run test
```

## ๐Ÿค Contributing

If you want to contribute:

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

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

3. Make your changes and commit:

```bash
git commit -m "Add new feature"
```

4. Push your branch to your fork:

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

5. Open a Pull Request to the main repository

## ๐Ÿ“„ License

This project is licensed under the **MIT License**.

---