Welcome to the myContacts project! This application allows you to manage your contacts with ease. Below you will find instructions on how to set up the project and perform basic CRUD (Create, Read, Update, Delete) operations.
-
Clone the repository:
git clone https://github.com/yourusername/myContacts.git
-
Navigate to the project directory:
cd myContacts -
Install the dependencies:
npm install
-
Set up environment variables:
Create a .env file in the root directory and add the following variables:PORT=5000 MONGODB_URI=your_mongodb_connection_string ACCESS_TOKEN_SECRET=your_secret_key
-
Start the application:
npm start
Once the application is running, you can access it at http://localhost:5000. The application interface allows you to add, view, update, and delete contacts.
To create a new contact, send a POST request to /api/contacts with the contact details in the request body. Ensure you include a valid JWT token in the Authorization header.
POST /api/contacts
Content-Type: application/json
Authorization: Bearer your_jwt_token
{
"name": "Harsh",
"email": "[email protected]",
"phone": "123-456-7890"
}
201 Created
{
"_id": "contact_id",
"name": "Harsh",
"email": "[email protected]",
"phone": "123-456-7890",
"user_id": "user_id"
}
To retrieve all contacts, send a GET request to /api/contacts with a valid JWT token in the Authorization header.
GET /api/contacts
Authorization: Bearer your_jwt_token
200 OK
[
{
"_id": "contact_id",
"name": "Harsh",
"email": "[email protected]",
"phone": "123-456-7890",
"user_id": "user_id"
},
...
]
To retrieve a single contact, send a GET request to /api/contacts/:id with a valid JWT token in the Authorization header.
GET /api/contacts/:id
Authorization: Bearer your_jwt_token
200 OK
{
"_id": "contact_id",
"name": "Harsh",
"email": "[email protected]",
"phone": "123-456-7890",
"user_id": "user_id"
}
To update an existing contact, send a PUT request to /api/contacts/:id with the updated contact details in the request body. Ensure you include a valid JWT token in the Authorization header.
PUT /api/contacts/:id
Content-Type: application/json
Authorization: Bearer your_jwt_token
{
"name": "Jogo",
"email": "[email protected]",
"phone": "987-654-3210"
}
200 OK
{
"_id": "contact_id",
"name": "Jogo",
"email": "[email protected]",
"phone": "987-654-3210",
"user_id": "user_id"
}
To delete a contact, send a DELETE request to /api/contacts/:id with a valid JWT token in the Authorization header.
DELETE /api/contacts/:id
Authorization: Bearer your_jwt_token
200 OK
{
"_id": "contact_id",
"name": "Harsh",
"email": "[email protected]",
"phone": "123-456-7890",
"user_id": "user_id"
}
Contributions are welcome! Personally, I AJ Harsh Vardhan likes it when you contribute. Please create a pull request with your changes and ensure your code follows the project's coding standards.