iamomar22 / myalice---contact-management-system

TO SEE THE FULL FUNCTIONALITY, YOU NEED TO RUN THE PROJECT LOCALLY. BECAUSE FEW FUNCTIONS MAY NOT WORK PROPERLY IN THE PRODUCTION VERSION. ACTUALLY, I AM DOING A FULL-TIME JOB, SO DIDN'T GET MUCH TIME FOR THE FRONTEND. THE TASK IS FULLY DONE.I IMPLEMENTED EVERYTHING.

CONTACT MANAGEMENT SYSTEM

SETUP INSTRUCTIONS (KEEP BACKEND AND FRONTEND RUNNING BOTH)

BACKEND RUN

1. CLONE THE BACKEND REPOSITORY:

   git clone https://github.com/IamOmaR22/MyAlice---Contact-Management-System.git

2. NAVIGATE TO THE BACKEND DIRECTORY:

   cd MyAlice---Contact-Management-System/backend

3. INSTALL PYTHON DEPENDENCIES:

   pip install -r requirements.txt

4. APPLY DATABASE MIGRATIONS:

   python manage.py migrate

5. RUN THE DJANGO DEVELOPMENT SERVER:

   python manage.py runserver

FRONTEND RUN

1. NAVIGATE TO THE FRONTEND DIRECTORY:

   cd MyAlice---Contact-Management-System/frontend

2. INSTALL NODE.JS DEPENDENCIES:

   npm install

3. START THE REACT DEVELOPMENT SERVER:

   npm start

BACKEND (DJANGO)

THE BACKEND IS DEVELOPED USING DJANGO AND PROVIDES RESTFUL APIs FOR MANAGING CONTACTS AND AUTHENTICATION.

FRONTEND (REACT)

THE FRONTEND IS DEVELOPED USING REACT AND MATERIAL UI FOR MANAGING CONTACTS AND AUTHENTICATION.

AUTHENTICATION

• JWT (JSON WEB TOKENS) FOR USER AUTHENTICATION
• REGISTER
• LOGIN
• LOGOUT

FEATURES

• REGISTER ACCOUNT
• LOGIN
• LOGOUT
• LIST ALL CONTACTS
• ADD A NEW CONTACT - NEED TO LOGIN
• UPDATE AN EXISTING CONTACT
• DELETE A CONTACT

DATABASE

• SQLITE (IN-MEMORY DATABASE FOR THIS TASK)

THIS IS A SIMPLE CONTACT MANAGEMENT SYSTEM DEVELOPED USING DJANGO FOR THE BACKEND AND REACT FOR THE FRONTEND. IT ALLOWS USERS TO PERFORM CRUD OPERATIONS (CREATE, READ, UPDATE, DELETE) ON CONTACT INFORMATION.

ENJOY YOUR CONTACT MANAGEMENT SYSTEM!