README.MD

📘 Backend for App

• 📚 Root/📕 Frontend/
• 📚 Root/📘 Backend/

📖 Table of Contents

• 📘 Backend for App
  • 📖 Table of Contents
  • 👀 Motivation 🔝
  • 🧰 Technology Stack 🔝
  • 🤵‍♂️ Team communication channels 🔝
  • 🧑‍💻 Developer Teams 🔝
  • 🗃️ Project info 🔝
    • 📚 License 🔝
    • 📚 Workspaces 🔝
    • 📚 Deploy 🔝
  • 🛠️ Requirements 🔝
    • 1. Clone the repository from GitHub
    • 2. Navigate to the backend folder
    • 3. Install the necessary dependencies
    • 4 In the backend folder, create a .env file
    • 5. Add the following keys to the .env file
    • 6. Run the following command to start the server
    • 7. Open your browser and navigate to http://localhost:3001/api/v1/docs
  • 🎚️ Scripts 🔝
  • 🩻 Progress Report on Router Development 🔝
    • ✨ Root Base
    • ✨ Start Route 🔝
    • ⛔ Invalid Route 🔝
    • 📑 Docs Route 🔝
    • 🔐 Authorization Routes 🔝

👀 Motivation 🔝

Elegimos utilizar Python junto con PostgreSQL para el backend de nuestra aplicación de recursos humanos porque estas tecnologías nos ofrecen una solución robusta y escalable. Python es conocido por su legibilidad y facilidad de uso, lo que acelera el desarrollo y permite a nuestro equipo implementar nuevas funcionalidades rápidamente. Por otro lado, PostgreSQL, como una de las bases de datos relacionales más avanzadas, proporciona una gestión eficiente y segura de datos, garantizando la integridad y consistencia necesaria en la administración del talento humano. Esta combinación nos permite construir una plataforma confiable y flexible, capaz de adaptarse a las necesidades cambiantes del proyecto.

🧰 Technology Stack 🔝

🤵‍♂️ Team communication channels 🔝

🧑‍💻 Developer Teams 🔝

Anthony Bañon	Juan Novas

🗃️ Project info 🔝

📚 License 🔝

License

📚 Workspaces 🔝

Name	Path	Description
🎛️ Backend	/backend	application Back-End

📚 Deploy 🔝

Description	Deploy	link
Backend	Por desplegar	Sin enlace
Data Base	Por desplegar	Sin enlace

🛠️ Requirements 🔝

Make sure you have Docker installed. If you don't have it, click here to go to the official site and download it.

1. Clone the repository from GitHub

git clone https://github.com/No-Country-simulation/s18-03-m-python-react.git

2. Navigate to the backend folder

cd s18-03-m-python-react

3. Execute the container

docker-compose up -d --build

4. Open your browser and navigate to http://localhost:3000

✨ Root Base

http://localhost:3000

✨ Start Route 🔝

Method	Router	Endpoint	Documentation	Api Key	Token
Get	/	✔️	❌	❌	❌
Get	/api	✔️	❌	❌	❌
Get	/api/v1	✔️	❌	❌	❌

⛔ Invalid Route 🔝

Method	Router	Endpoint	Documentation	Api Key	Token
Get	/*	✔️	✔️	❌	❌

📑 Docs Route 🔝

Method	Router	Endpoint	Documentation	Api Key	Token
Get	/api/v1/docs	✔️	✔️	❌	❌

🔐 Authorization Routes 🔝

Method	Router	Endpoint	Documentation	Api Key	Token
Get	/user/profile	✔️	✔️	✔️	✔️
Post	/user/register	✔️	✔️	✔️	❌
Post	/user/login	✔️	✔️	✔️	❌