https://github.com/athulsabu2002/contactmanager
A simple contact manager website to manage all your contacts.
https://github.com/athulsabu2002/contactmanager
contact-manager html-css-javascript mongodb nodejs website
Last synced: 3 months ago
JSON representation
A simple contact manager website to manage all your contacts.
- Host: GitHub
- URL: https://github.com/athulsabu2002/contactmanager
- Owner: AthulSabu2002
- Created: 2024-02-03T17:28:34.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-01T16:33:34.000Z (about 1 year ago)
- Last Synced: 2025-01-16T13:18:42.644Z (9 months ago)
- Topics: contact-manager, html-css-javascript, mongodb, nodejs, website
- Language: CSS
- Homepage: https://contactmanager-khdn.onrender.com/
- Size: 5.98 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ContactSphere
Welcome to the Contact Manager website! This web application allows users to manage their contacts, providing features like creating, editing, and deleting contacts. Additionally, it includes user authentication, session management, and other functionalities.
## Table of Contents
- [Features](#features)
- [Getting Started](#getting-started)
- [Dependencies](#dependencies)
- [Usage](#usage)
- [Routes](#routes)
- [Contributing](#contributing)
- [License](#license)
## Features
- User Authentication with Passport.js
- Session Management using Express Session
- Contact Management (Create, Read, Update, Delete)
- Password Reset Functionality
- User Dashboard
- ...
## Getting Started
To get started with the Contact Manager website, follow these steps:
1. Clone the repository:
```bash
git clone https://github.com/AthulSabu2002/contactManager.git
cd contactManager
```
2. Install dependencies:
```bash
npm install
```
3. Configure environment variables:
Create a `.env` file in the root directory and add the necessary environment variables:
```env
PORT=5000
DATABASE_URL=mongodb://your-mongodb-url
APP_PASSWORD=your-app-password-for-email
MYEMAIL=your-email
```
4. Run the application:
```bash
npm start
```
The server will be running on `http://localhost:5000` (or the port specified in your `.env` file).
## Dependencies
- Express.js
- MongoDB (with Mongoose)
- Passport.js
- Express Session
- ...
Make sure to check the `package.json` file for a complete list of dependencies.
## Usage
1. **User Registration:**
- Navigate to `/registerUserWithOTP` to register a new user with OTP verification.
2. **User Authentication:**
- Login at `/` or `/users/login`.
3. **Contact Management:**
- Create a new contact at `/createContact`.
- View contacts at `/view-contact`.
- Edit a contact at `/edit/:id`.
- Delete a contact at `/deleteContact`.
4. **Password Reset:**
- Forgot password at `/forgot`.
- Reset password using the provided token at `/reset/:token`.
5. **User Dashboard:**
- Access the user dashboard at `/dashboard`.
6. **Other Routes:**
- Explore other routes based on your application's functionalities.
## Routes
- `/` - Home Page or Login Page
- `/users` - User Authentication Routes
- `/forgot` - Forgot Password
- `/reset/:token` - Password Reset
- `/logout` - Logout
- `/dashboard` - User Dashboard
- `/view-contact` - View Contacts
- `/createContact` - Create a Contact
- `/edit/:id` - Edit a Contact
- `/deleteContact` - Delete a Contact
- `/verifyOtp` - Verify OTP
- `/registerUserWithOTP` - Register User with OTP