-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
111 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 | ||
|
|
||
| <a name='hld'></a> | ||
|
|
||
| ## 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 | ||
|
|
||
| <a name="drf"></a> | ||
|
|
||
| ### Django-Rest-Framework GUI | ||
|
|
||
| - Home Page API Root Page | ||
|
|
||
|  | ||
|
|
||
| - Employee2 's API | ||
|  | ||
|
|
||
| - Role2 API Page | ||
|  | ||
|
|
||
| - Department 2 API | ||
|  | ||
|
|
||
| ## POST MAN | ||
|
|
||
| - GET Operation | ||
| - Fetch Single Employee Using Employee ID | ||
|
|
||
|  | ||
|
|
||
| - GET Operations - 500 Employee Data | ||
|  | ||
| - POST Operation | ||
| -  | ||
| - PUT Operations  | ||
| - PATCH Operations | ||
|  |