Contact Circle

Contact Circle is a simple contact app that allows you to list your contacts based on the closeness of the people in your life. This project serves as a demonstration of a Node.js application showcasing the MERN (MongoDB, Express.js, React, Node.js) architecture and how to build a RESTful API server.

Features

• User-friendly interface to manage your contacts.
• Sort contacts by the closeness of your relationships.
• Add new contacts with ease.
• Edit or delete existing contacts.
• A RESTful API server for data management.

Technologies Used

• MongoDB: Used for storing and managing contact data.
• Express.js: A Node.js web application framework for building the API server.
• React: Front-end library for creating interactive and dynamic user interfaces.
• Node.js: Server runtime for building the back-end of the application.
• And More: Axios, Cors, Formik, Mongoose, PM2, Tailwind, Animista, Font Awesome

API Endpoints

• GET /api/contacts: Get a list of all contacts.
• GET /api/contact: Get a specific contact.
• POST /api/contact/upload: Create a new contact.
• POST /api/contact/update: Update a contact.
• POST /api/contact/delete: Delete a contact.

Installation

To run this project locally, follow these steps:

1. Clone the repository:

   git clone https://github.com/your-username/contact-circle.git
   

2. Navigate to the project directory:

   cd Contact-Circle
   

3. Update Environment Variable files:

   /Server/.env
   /Client/src/env.js
   

4. Install server dependencies and start:

   cd Server
   npm install
   npm start
   

5. Install client dependencies and start:

   cd Cerver
   npm install
   npm start
   

6. Open your web browser and go to http://localhost:3000 to use Contact Circle.

Contributing

Check out the contributing guidelines

License

This project is licensed under the MIT License.