https://github.com/rir360/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.
https://github.com/rir360/contact-circle

animista axios cors express font-awesome formik mongodb mongoose nodejs pm2 reactjs rir360 tailwind tailwindcss

Last synced: about 1 month ago
JSON representation

Contact Circle is a simple contact app that allows you to list your contacts based on the closeness of the people in your life.

• Host: GitHub
• URL: https://github.com/rir360/contact-circle
• Owner: RIR360
• License: mit
• Created: 2023-09-03T07:02:56.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-11-11T18:46:49.000Z (about 1 year ago)
• Last Synced: 2023-11-11T19:32:07.873Z (about 1 year ago)
• Topics: animista, axios, cors, express, font-awesome, formik, mongodb, mongoose, nodejs, pm2, reactjs, rir360, tailwind, tailwindcss
• Language: JavaScript
• Homepage:
• Size: 875 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![Contact circle MERN app preview made by Rejwan Islam Rizvy, Rizvi](https://github.com/RIR360/Contact-Circle/assets/50569315/60f13e4e-2412-43da-902d-ef8e74491f87)

# 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:

   ```bash

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

2. Navigate to the project directory:

   ```bash

   cd Contact-Circle

3. Update Environment Variable files:

   ```bash

   /Server/.env

   /Client/src/env.js

4. Install server dependencies and start:

   ```bash

   cd Server

   npm install

   npm start

   

5. Install client dependencies and start:

   ```bash

   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](https://github.com/RIR360/Contact-Circle/blob/main/CONTRIBUTING.md)

## License

This project is licensed under the [MIT License](https://github.com/RIR360/Contact-Circle/blob/main/LICENSE).