Skip to content

Commit

Permalink
docs: Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mobinghoveoud committed Oct 13, 2024
1 parent 95e908d commit 475a6c7
Showing 1 changed file with 5 additions and 16 deletions.
21 changes: 5 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ implemented Django views and DRF APIs, users can easily add new mobile phones, u
the data they need. The system is designed to streamline inventory management, ensuring accurate and up-to-date
information for the store's mobile stock.

---

## Table of Contents

1. [Key Features](#key-features)
Expand All @@ -32,8 +30,6 @@ information for the store's mobile stock.
+ [Running pre-commit manually](#running-pre-commit-manually)
+ [Skipping pre-commit hooks](#skipping-pre-commit-hooks)

---

## Key Features

- **Django & DRF-Based**: This project is built using Django and Django REST Framework (DRF), utilizing both traditional
Expand All @@ -55,8 +51,6 @@ information for the store's mobile stock.
- **Detailed Documentation**: All aspects of the project have been thoroughly documented in both the `README.md` and
the `docs` section, providing detailed explanations of the system's functionality.

---

## Getting Started

### Prerequisites
Expand Down Expand Up @@ -109,8 +103,6 @@ information for the store's mobile stock.

3. Access the project at `http://localhost:80`.

---

## Running the Tests

You can run the tests with this command:
Expand All @@ -119,8 +111,6 @@ You can run the tests with this command:
python manage.py test --settings=core.settings.test
```

---

## Project Structure

### Apps
Expand All @@ -144,13 +134,15 @@ The project has multiple settings files:
- Configuration for the testing environment.
- Inherits from the development settings but uses a separate test database and some test-specific settings.

+ Production Settings
- File: [settings/production.py](src/core/settings/production.py)
- Configuration for the production environment.

### Static and Media Files

The project uses Django's built-in static and media file handling. Static files (CSS) are stored in the `static`
directory, while media files (uploaded images) are stored in the `media` directory.

---

## API Specification

### Korea Brands API
Expand Down Expand Up @@ -226,8 +218,6 @@ GET /api/same-nationality/
- **406 Not Acceptable**: Returns an error response if the value provided for the `flat` parameter is not a valid
integer.

---

## Swagger Documentation

The project includes Swagger documentation for the API routes. Below are the Swagger routes and their descriptions:
Expand All @@ -245,8 +235,7 @@ For example:

- Swagger UI: `http://localhost:80/api/schema/swagger-ui/`
- ReDoc: `http://localhost:80/api/schema/redoc/`

---
- Schema YML File: [schema.yml](src/schema.yml)

## Pre-commit

Expand Down

0 comments on commit 475a6c7

Please sign in to comment.