Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/njorogemaurice/contactmanagement
Contact Management is a web application that enables users to create, read, update and delete contact records. In addition, users can categorize the contacts into groups
https://github.com/njorogemaurice/contactmanagement
contact-management-system laravel-framework mysql-database php8 web-application
Last synced: 15 days ago
JSON representation
Contact Management is a web application that enables users to create, read, update and delete contact records. In addition, users can categorize the contacts into groups
- Host: GitHub
- URL: https://github.com/njorogemaurice/contactmanagement
- Owner: NjorogeMaurice
- Created: 2024-06-14T00:40:36.000Z (7 months ago)
- Default Branch: master
- Last Pushed: 2024-06-14T20:25:52.000Z (7 months ago)
- Last Synced: 2024-06-15T09:49:30.321Z (7 months ago)
- Topics: contact-management-system, laravel-framework, mysql-database, php8, web-application
- Language: PHP
- Homepage:
- Size: 146 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Contact Management System
This is a Contact Management System built with Laravel. It allows users to manage their contacts and groups efficiently. Users can create, read, update, and delete contacts and groups, providing a simple yet powerful way to organize and keep track of their personal or professional network.
## Table of Contents
- [Introduction](#introduction)
- [Features](#features)
- [Technologies Used](#technologies-used)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Running the Project](#running-the-project)
- [License](#license)
## Introduction
The Contact Management System is designed to help users manage their contacts and group them as needed. This project includes user authentication and authorization features to ensure that users can securely manage their information.
## Features
- User authentication and authorization
- CRUD operations for contacts
- CRUD operations for groups
- Group assignment for contacts
- Responsive design
## Technologies Used
- Laravel
- PHP
- MySQL
- Blade Templating
- Tailwind CSS
- JavaScript
## Prerequisites
Before you begin, ensure you have met the following requirements:
- PHP >= 7.3
- Composer
- MySQL
- Node.js and npm (for compiling assets)
- Git
## Installation
Follow these steps to set up and run the project locally
### 1. Clone the Repository
```bash
git clone https://github.com/NjorogeMaurice/ContactManagement.git
cd ContactManagement
```
### 2. Install Dependencies
Use Composer to install PHP dependencies
```bash
composer install
```
Use npm to install JavaScript dependencies
```bash
npm install
npm run dev
```
### 3. Set Up Environment Variables
Create a .env and configure your environment variables, especially the database settings
Add the following lines. Replace with your credentials
```bash
DB_DATABASE=my_laravel_db
DB_USERNAME=laravel_user
DB_PASSWORD=your_password
```
### 4. Generate Application Key
```bash
php artisan key:generate
```
### 5. Run Database Migrations and Seeders
```bash
php artisan migrate --seed
```
## Running the Project
You can serve/run the application using the built-in Laravel server:
```bash
php artisan serve
```
Then open your browser at http://localhost:8000.
