diff --git a/EmployeeManagementSystem/apiV1/README.md b/EmployeeManagementSystem/apiV1/README.md new file mode 100644 index 00000000..d5b135c7 --- /dev/null +++ b/EmployeeManagementSystem/apiV1/README.md @@ -0,0 +1,111 @@ +# Welcome to Coder Its OneNuman! + +## Its [django-RBAC-Employee-Management-System-With-API](https://github.com/one-numan/django-RBAC-Employee-Management-System-With-API) + +### Its _version1.1.1_ - + +**_Hope Your Doing Great_** + +- What I Built in this Version . + 1. API + - No Authentication /No Token Required + - Perform **CRUD** Operation are : + - GET , + - POST, + - PUT, + - PATCH , + - DELETE + - Using DRF ( **Django Rest Framework** ) + - Provide Better UI for REST's CRUD Operations + 2. Database + - Added a 500+ Employees Data ( Dummy Data ) + - DB have 3 Tables + - Employee2 + - Department2 + - Role2 + - _Note table_name **2** Represent , Its Second Table_ + - \*These Names tables Already Exist so Created New Table with ends With **2\*** + +## Table of Contents + +If your README is long, add a table of contents to make it easy for users to find what they need. + +- [About](#about) +- [Installation](#installation) +- [High Level Design](#hld) +- [Run this Project](#run) + - [Django-Rest-Framework GUI](#drf) + - [PostMan](#pm) + +## About + +| Project Name | Employee Management System | +| ------------ | -------------------------- | +| **Version** | 1.1.1 | + +_Its a Very BASIC REST API WITH NO Authentication_ + +--- + +| Modules / Library Name | Version | +| ----------------------------- | ------- | +| Python | 3.10.8 | +| Django | 4.2.8 | +| Django Rest Framework **New** | 3.14.0 | +| Sqlite | 3.44 | + +## Installation + +1. Clone this Repo +2. Install Python3 +3. Installing Required Python Modules from File **Requirements.txt** + - Command `pip install -r requirements.txt` +4. Installed IDE like VSCode or Pycharm + + + +## High Level Design + +Major Steps + +1. Install Django & DRF +2. Create New App +3. Set-Up Django Models +4. Set-Up Serializers +5. Set-Up Views +6. Set-Up URLs +7. Test Your API + +## Run this Project + + + +### Django-Rest-Framework GUI + +- Home Page API Root Page + + ![image](https://github.com/one-numan/django-RBAC-Employee-Management-System-With-API/assets/48924562/132165b0-10be-495d-91d6-6bcd2e90519b) + +- Employee2 's API + ![image](https://github.com/one-numan/django-RBAC-Employee-Management-System-With-API/assets/48924562/e4fdfb60-9139-4925-99be-f08fd42d60ea) + +- Role2 API Page + ![image](https://github.com/one-numan/django-RBAC-Employee-Management-System-With-API/assets/48924562/0c452d70-1b28-4bef-b16f-623bd14a11e9) + +- Department 2 API + ![image](https://github.com/one-numan/django-RBAC-Employee-Management-System-With-API/assets/48924562/6028afbe-9e6d-4b79-afc5-f39d9d03f926) + +## POST MAN + +- GET Operation +- Fetch Single Employee Using Employee ID + +![image](https://github.com/one-numan/django-RBAC-Employee-Management-System-With-API/assets/48924562/d4c5f3df-8453-42b9-bb47-e5ea8343ba7a) + +- GET Operations - 500 Employee Data + ![image](https://github.com/one-numan/django-RBAC-Employee-Management-System-With-API/assets/48924562/ba0a9138-3145-49e7-a83f-1758abb9670b) +- POST Operation + - ![image](https://github.com/one-numan/django-RBAC-Employee-Management-System-With-API/assets/48924562/633c9465-11e3-44d4-8198-8b94bb5160d3) +- PUT Operations ![image](https://github.com/one-numan/django-RBAC-Employee-Management-System-With-API/assets/48924562/5abae87f-6661-4c09-8f7f-5b16f866f773) +- PATCH Operations + ![image](https://github.com/one-numan/django-RBAC-Employee-Management-System-With-API/assets/48924562/a5df5e82-29b1-4ce0-aeb6-42c489556aaf)