{"id":22671313,"url":"https://github.com/donyscode/plibraryx","last_synced_at":"2025-03-29T11:21:45.530Z","repository":{"id":264565675,"uuid":"893231786","full_name":"DonySCode/plibraryx","owner":"DonySCode","description":"PLibraryX es un sistema de gestión de biblioteca personal, que te permitirá administrar tus libros de forma organizada.","archived":false,"fork":false,"pushed_at":"2024-11-25T05:05:33.000Z","size":1622,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-04T11:51:54.904Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://plibraryx.donycastro.me/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/DonySCode.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-11-23T21:55:35.000Z","updated_at":"2024-11-26T14:12:22.000Z","dependencies_parsed_at":"2024-11-25T04:29:02.828Z","dependency_job_id":"bd200866-7025-4506-9300-18310e78eaeb","html_url":"https://github.com/DonySCode/plibraryx","commit_stats":null,"previous_names":["donyscode/plibraryx"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DonySCode%2Fplibraryx","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DonySCode%2Fplibraryx/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DonySCode%2Fplibraryx/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DonySCode%2Fplibraryx/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DonySCode","download_url":"https://codeload.github.com/DonySCode/plibraryx/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246175217,"owners_count":20735523,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-09T16:14:11.797Z","updated_at":"2025-03-29T11:21:45.504Z","avatar_url":"https://github.com/DonySCode.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# PLibraryX\n\nPLibraryX es un sistema de gestión de biblioteca personal, que te permitirá administrar tus libros de forma organizada.\n\n## Requerimientos\n\nPara ejecutar este proyecto, necesitas tener instalados los siguientes componentes:\n- Node.js\n- PostgreSQL\n\n## Instalación\n\n1. Clona el repositorio:\n   ```bash\n   git clone https://github.com/DonySCode/plibraryx.git\n   cd plibraryx\n   ```\n\n2. Llena las variables necesarias en los archivos `.env` y `.env.local` en las carpetas `backend` y `frontend`. Aquí tienes ejemplos de como llenar estas variables:\n\n   - `frontend/.env.local`:\n     ```dotenv\n     NEXT_PUBLIC_API_URL=http://localhost:8080/api\n     ```\n\n   - `backend/.env`:\n     ```dotenv\n     DB_HOST=locahost\n     DB_PORT=5432\n     DB_USER=postgres\n     DB_PASSWORD=PasswordDeDony\n     DB_NAME=plibraryx\n     JWT_SECRET=misecretito\n     PORT=8080\n     ```\n\n3. Instala las dependencias del frontend:\n   ```bash\n   cd frontend\n   npm install\n   ```\n\n4. Instala las dependencias del backend:\n   ```bash\n   cd ../backend\n   npm install\n   ```\n\n## Scripts\n\nPara ejecutar el servidor de desarrollo tanto para el frontend como para el backend, usa el siguiente comando en la carpeta raíz del proyecto:\n```bash\nnpm run backend:dev\nnpm run frontend:dev\n```\n\nEsto ejecutará los siguientes scripts:\n- `frontend:dev`: Navega a la carpeta `frontend` y ejecuta el comando `npm run dev`.\n- `backend:dev`: Navega a la carpeta `backend` y ejecuta el comando `npm run dev`.\n\n---\n\n## Documentación de la API\n\n### Usuarios\n\n- **POST /api/users/register**\n  - Registro de un nuevo usuario.\n  - Cuerpo de la solicitud:\n    ```json\n    {\n      \"username\": \"string\",\n      \"email\": \"string\",\n      \"password\": \"string\"\n    }\n    ```\n\n- **POST /api/users/login**\n  - Inicio de sesión de un usuario.\n  - Cuerpo de la solicitud:\n    ```json\n    {\n      \"email\": \"string\",\n      \"password\": \"string\"\n    }\n    ```\n\n### Libros\n\n- **POST /api/books/**\n  - Añadir un nuevo libro.\n  - Cuerpo de la solicitud:\n    ```json\n    {\n     \"title\": \"string\",\n     \"author\":  \"string\",\n     \"year\": \"number\",\n     \"genre\": \"string[]\",\n     \"coverImage\": \"string\",\n     \"rating\":  \"number\",\n     \"isFavorite\": \"boolean\",\n    }\n    ```\n\n- **GET /api/books/**\n  - Obtener todos los libros.\n\n- **GET /api/books/:id**\n  - Obtener un libro por su ID.\n\n- **PUT /api/books/:id**\n  - Actualizar un libro por su ID.\n  - Cuerpo de la solicitud:\n    ```json\n    {\n     \"title\": \"string\",\n     \"author\":  \"string\",\n     \"year\": \"number\",\n     \"genre\": \"string[]\",\n     \"coverImage\": \"string\",\n     \"rating\":  \"number\",\n     \"isFavorite\": \"boolean\",\n    }\n    ```\n\n- **DELETE /api/books/:id**\n  - Eliminar un libro por su ID.\n\n- **PATCH /api/books/:id/favorite**\n  - Marcar un libro como favorito.\n\n- **PATCH /api/books/:id/unfavorite**\n  - Desmarcar un libro como favorito.\n\n---\n\n## Deploy Funcional\n\nhttp://plibraryx.donycastro.me/\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdonyscode%2Fplibraryx","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdonyscode%2Fplibraryx","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdonyscode%2Fplibraryx/lists"}