Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/leonel-h29/stockcontrol
Trabajo integrador: Sistema de Gestión de Stock
https://github.com/leonel-h29/stockcontrol
django django-rest-framework nextjs python typescript
Last synced: about 2 months ago
JSON representation
Trabajo integrador: Sistema de Gestión de Stock
- Host: GitHub
- URL: https://github.com/leonel-h29/stockcontrol
- Owner: Leonel-H29
- Created: 2024-02-18T15:01:55.000Z (10 months ago)
- Default Branch: master
- Last Pushed: 2024-04-09T18:57:56.000Z (9 months ago)
- Last Synced: 2024-04-09T23:22:17.736Z (9 months ago)
- Topics: django, django-rest-framework, nextjs, python, typescript
- Language: TypeScript
- Homepage:
- Size: 373 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Sistema de Gestión de Stock
## Introducción al Proyecto
Este proyecto consiste en un sistema de gestión de stock diseñado para facilitar el manejo de productos y proveedores. Permite a los usuarios realizar operaciones CRUD (Crear, Leer, Actualizar, Eliminar) sobre los productos y los proveedores. La aplicación está dividida en un backend, desarrollado con Django Rest Framework, y un frontend, creado con Next.js y TypeScript.
## Tecnologías Utilizadas
- **Backend**: Python, Django, Django Rest Framework
- **Frontend**: TypeScript, Next.js, React, Tailwind CSS
- **Base de Datos**: SQLite
- **Autenticación**: JWT,
## Endpoints del Backend
Los endpoints disponibles en el backend son los siguientes:
- **Productos**:
- Listar todos los productos: `GET /api/productos/`
- Crear un nuevo producto: `POST /api/productos/`
- Obtener detalles de un producto: `GET /api/productos/{id}/`
- Actualizar un producto: `PUT /api/productos/{id}/`
- Eliminar un producto: `DELETE /api/productos/{id}/`
- **Proveedores**:
- Listar todos los proveedores: `GET /api/proveedores/`
- Crear un nuevo proveedor: `POST /api/proveedores/`
- Obtener detalles de un proveedor: `GET /api/proveedores/{id}/`
- Actualizar un proveedor: `PUT /api/proveedores/{id}/`
- Eliminar un proveedor: `DELETE /api/proveedores/{id}/`
- **Usuarios**:
- Registrar un nuevo usuario: `POST /api/register/`
- Iniciar sesión: `POST /api/login/`
Para probar los endpoints en Swagger, siga estos pasos:
1. Navegue a `/swagger/` en su navegador para acceder a la interfaz de usuario de Swagger.
2. Para los endpoints que requieren autenticación, primero debe obtener un token utilizando el endpoint de inicio de sesión (`POST /api/login/`). Deberá proporcionar un nombre de usuario y contraseña válidos en el cuerpo de la solicitud.
3. Una vez que tenga un token, puede utilizarlo para autenticarse en los endpoints protegidos. En Swagger, haga clic en el botón "Authorize" y escriba "Token " seguido de su token de autenticación en el campo de valor. Asegúrese de incluir el espacio después de "Token".
4. Ahora puede probar los endpoints protegidos utilizando la interfaz de Swagger, pasando los parámetros necesarios según lo requiera cada endpoint.
## Panel de Administración de Django
Django proporciona un panel de administración robusto y fácil de usar, que permite a los administradores del sistema gestionar el contenido del sitio de manera eficiente. Este panel es altamente personalizable y se puede adaptar para satisfacer las necesidades específicas de cualquier proyecto.
Para acceder al panel de administración, primero debe crearse un superusuario utilizando el comando `python manage.py createsuperuser` desde la línea de comandos. Una vez creado, puede acceder al panel visitando `/admin` en su navegador y utilizando las credenciales del superusuario.
### Características Principales:
- **Gestión de Usuarios**: Administre los usuarios de su aplicación, incluyendo la creación, edición y eliminación de usuarios.
- **Gestión de Modelos**: Acceda y modifique los datos de los modelos registrados, como `Productos` y `Proveedores`, directamente desde la interfaz.
- **Personalización**: Personalice la apariencia y el comportamiento del panel de administración para adaptarlo a las necesidades de su proyecto.
- **Seguridad**: El panel de administración incluye varias características de seguridad, como la autenticación de usuarios y la gestión de permisos.
### Ejemplo de Personalización:
Para personalizar la visualización de los modelos en el panel de administración, puede modificar los archivos `admin.py` dentro de sus aplicaciones. Por ejemplo, para el modelo `Producto`, se ha definido una clase `ProductoAdmin` que especifica cómo se deben mostrar los productos en el panel.
## Vistas del Frontend
Las vistas disponibles en el frontend son las siguientes:
- **Home**: Página de inicio que muestra un mensaje de bienvenida al usuario.
- **Login**: Página para iniciar sesión.
- **Register**: Página para registrar un nuevo usuario.
- **Listado de Productos**: Muestra un listado de todos los productos disponibles.
- **Crear Producto**: Formulario para crear un nuevo producto.
- **Editar Producto**: Formulario para editar un producto existente.
- **Listado de Proveedores**: Muestra un listado de todos los proveedores disponibles.
- **Crear Proveedor**: Formulario para crear un nuevo proveedor.
- **Editar Proveedor**: Formulario para editar un proveedor existente.
Cada una de estas vistas está diseñada para ser responsiva y fácil de usar, aprovechando las capacidades de Tailwind CSS para crear una interfaz de usuario atractiva y funcional.
## Ejecución Local del Proyecto
Para ejecutar localmente tanto el backend como el frontend de este proyecto, siga las instrucciones específicas para su sistema operativo.
### Backend (Django)
#### Windows
1. Abra una terminal y navegue hasta la carpeta del proyecto.
2. Cree un entorno virtual ejecutando: `python -m venv venv`
3. Active el entorno virtual: `.\venv\Scripts\activate`
4. Instale las dependencias: `pip install -r requirements.txt`
5. Ejecute las migraciones: `python manage.py migrate`
6. Inicie el servidor: `python manage.py runserver`
#### macOS/Linux
1. Abra una terminal y navegue hasta la carpeta del proyecto.
2. Cree un entorno virtual ejecutando: `python3 -m venv venv`
3. Active el entorno virtual: `source venv/bin/activate`
4. Instale las dependencias: `pip install -r requirements.txt`
5. Ejecute las migraciones: `python3 manage.py migrate`
6. Inicie el servidor: `python3 manage.py runserver`
### Frontend (NextJS)
#### Windows/macOS/Linux
1. Abra una nueva terminal y navegue hasta la carpeta del frontend dentro del proyecto.
2. Instale las dependencias con: `npm install`
3. Inicie la aplicación: `npm start`
4. La aplicación debería abrirse automáticamente en su navegador. Si no es así, visite `http://localhost:3000`.
Estas instrucciones deberían permitirle ejecutar localmente el backend y el frontend del proyecto en su máquina, independientemente del sistema operativo que esté utilizando.