Bienvenido al repositorio de la API de Chelajs, el corazón del backend de chelajs.cl. Este proyecto, creado con dedicación para la comunidad, se construye sobre NestJS, un framework progresivo de Node.js, para ofrecer una API robusta y escalable.
Aquí encontrará las APIs que impulsan nuestro sitio web, gestionando datos esenciales como información de participantes, ofertas laborales, eventos y mucho más. Nos esforzamos por construir una plataforma que sirva a la comunidad de Javascript Chile, facilitando la conexión y el crecimiento profesional de sus miembros.
La documentación de la API REST se encuentra organizada en la carpeta docs/rest/. Le invitamos a consultar los siguientes documentos para obtener una comprensión detallada de nuestros endpoints y esquemas:
-
Documentación de Autenticación: Descubre cómo autenticar tus peticiones a la API y obtener acceso seguro a los recursos protegidos.
-
Documentación de Participantes: Explore los endpoints destinados a la gestión de la información de los participantes de la comunidad, incluyendo la consulta y actualización de perfiles.
-
Documentación de Ofertas de Trabajo: Infórmese sobre las funcionalidades para la gestión de ofertas laborales, desde la creación y consulta hasta la eliminación de las mismas.
-
Documentación de Eventos: Descubra los endpoints para la gestión de eventos dentro de la plataforma.
Para comenzar a utilizar y contribuir a este proyecto, siga estos pasos iniciales:
-
Clonar el repositorio:
git clone https://github.com/Chelas-js/chelajs-api.git cd chelajs-api -
Instalar dependencias: Asegúrese de tener bun instalado según las indicaciones del documento de contribuciones. Luego, ejecute:
bun i
-
Iniciar el servidor de desarrollo:
bun start:dev
Este comando iniciará el servidor en modo desarrollo, con recarga automática al detectar cambios en el código.
Agradecemos enormemente su interés en contribuir a Chelajs API. Para conocer las directrices de contribución, configuración del entorno de desarrollo, estructura del proyecto y cómo realizar pruebas, consulte nuestro documento de contribuciones.
Su participación es fundamental para el crecimiento y la mejora continua de este proyecto comunitario.
Como comunidad inclusiva y diversa, nos regimos por un código de conducta que todos los participantes deben seguir y respetar. Le animamos a leerlo para asegurar un ambiente colaborativo y respetuoso para todos.
La seguridad es una prioridad en Chelajs API. Para conocer nuestras políticas de seguridad, versiones soportadas y cómo reportar vulnerabilidades, consulte nuestro documento de seguridad.
¡Esperamos que disfrute explorando y contribuyendo a Chelajs API!