This repository contains a simple and user-friendly Address Book application developed with React. The application enables users to manage their contact information efficiently. Below is a detailed guide on the project.
- Features
- Getting Started
- Installation
- Usage
- Technologies Used
- Project Structure
- Contributing
- License
- Add Contacts: Add new contacts with essential details such as name, email, and phone number.
- Edit Contacts: Update existing contact information.
- Delete Contacts: Remove contacts from the address book.
- Responsive Design: Optimized for both mobile and desktop devices.
- Persistent Data: Contacts are stored persistently using local storage or a backend (as applicable).
Follow these instructions to set up and run the project on your local machine for development and testing purposes.
Ensure you have the following installed on your local development environment:
- Node.js (v14 or higher)
- npm
-
- Clone the repository:
git clone https://github.com/debanshup/Address-Book.git cd Address-Book
- Install dependencies:
npm install [dependency]
- Start the development server:
npm start
- Navigate to the homepage.
- Fill out the form with the contact's name, email, and phone number.
- Click the Add Contact button to save the contact.
- Contacts will be listed on the homepage.
- To edit a contact, click the Edit button next to the contact. Modify the details in the form and save changes. (this feature is under development)
- To delete a contact, click the Delete button next to the contact. Confirm the action in the prompt. (this feature is under development)
- React: A JavaScript library for building user interfaces.
- React Router: Library for managing navigation in the application.
- HTML5: Markup language for structuring content on the web.
- CSS3: Stylesheet language used for describing the look and formatting of a document written in HTML.
- JavaScript (ES6+): Scripting language used to create dynamic content.
/src/
components/
- Contains React components like ContactForm
, ContactList
, etc.
utils/
- Utility functions.
App.js
- The root component that integrates all other components.
index.js
- Entry point for the React application.
Contributions are welcome! Please follow these steps:
- Fork the repository.
- Create a new branch:
git checkout -b feature-branch
- Commit your changes:
git commit -m 'Add new feature'
- Push to the branch:
git push origin feature-branch
This project is licensed under the MIT License. See the LICENSE file for details on the terms and conditions of the license.