Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/saurabh9136/corporate-directory-service
Corporate Directory Service is a Django-based web application for managing companies and their employees. It provides RESTful APIs for creating, updating, and retrieving company and employee information.
https://github.com/saurabh9136/corporate-directory-service
admin django django-rest-framework
Last synced: 11 days ago
JSON representation
Corporate Directory Service is a Django-based web application for managing companies and their employees. It provides RESTful APIs for creating, updating, and retrieving company and employee information.
- Host: GitHub
- URL: https://github.com/saurabh9136/corporate-directory-service
- Owner: saurabh9136
- Created: 2024-05-17T13:05:59.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-05-17T13:38:38.000Z (6 months ago)
- Last Synced: 2024-05-17T14:29:23.328Z (6 months ago)
- Topics: admin, django, django-rest-framework
- Language: Python
- Homepage:
- Size: 34.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Corporate-Directory-Service
Corporate Directory Service is a Django-based web application for managing companies and their employees. It provides RESTful APIs for creating, updating, and retrieving company and employee information.
## Features
- **Company Management**: Add, update, and retrieve information about companies including their name, location, type, and more.
- **Employee Management**: Manage employee details such as name, email, address, phone number, position, and associated company.
- **RESTful APIs**: Access company and employee data through easy-to-use RESTful APIs.
- **One-to-Many Relationship**: Maintain a one-to-many relationship between companies and employees.
- **Data Validation**: Ensure data integrity and accuracy through built-in data validation.
## Installation
1. Clone the repository:
```bash
git clone https://github.com/saurabh9136/Corporate-Directory-Service
2. Navigate to the project directory:
```bash
cd CorporateDirectoryService
3. Install dependencies:
```bash
pip install -r requirements.txt
4. Run migrations:
```bash
python manage.py migrate
5. Start the development server:
```bash
python manage.py runserver
6. Access the application in your web browser at http://127.0.0.1:8000
# Usage
- Use the provided RESTful APIs to perform CRUD operations on companies and employees.
- Access the API documentation and interact with the endpoints using tools like Postman or curl.
## API Endpoints
# Companies
GET /api/v1/companies/: Retrieve a list of all companies.
POST /api/v1/companies/: Create a new company.
GET /api/v1/companies//: Retrieve details of a specific company.
PUT /api/v1/companies//: Update details of a specific company.
DELETE /api/v1/companies//: Delete a specific company.
# Employees
GET /api/v1/employees/: Retrieve a list of all employees.
POST /api/v1/employees/: Create a new employee.
GET /api/v1/employees//: Retrieve details of a specific employee.
PUT /api/v1/employees//: Update details of a specific employee.
DELETE /api/v1/employees//: Delete a specific employee.
## Contributing
Contributions are welcome! If you'd like to contribute to this project, please follow these steps:
Fork the repository.
Create a new branch (git checkout -b feature/your-feature-name).
Commit your changes (git commit -am 'Add new feature').
Push to the branch (git push origin feature/your-feature-name).
Create a new pull request.