Skip to content

πŸ“š RESTful API for Latin American women poets' poems built with Node.js, Express, Sequelize and MySQL. Educational and cultural project to showcase the work of female poets from Latin America. ✨ Created for my YouTube channel alienexplorer

Notifications You must be signed in to change notification settings

tatianaborda/poetisas

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

4 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ“š Latin American Women Poets API

A RESTful API developed with Node.js, Express, Sequelize, and MySQL, that allows you to query, create, edit, and delete complete poems written by women poets from Latin America. Ideal for educational or cultural purposes. ❀️


πŸš€ Technologies Used

  • Node.js – JavaScript runtime environment
  • Express – web framework for Node.js
  • Sequelize – ORM for SQL databases
  • MySQL – database management system
  • MySQL Workbench – graphical tool for creating and managing databases
  • dotenv – environment variable management

πŸ“ Project Structure

poetisas-db/
β”œβ”€β”€ src/
β”‚   β”œβ”€β”€ models/             # Sequelize model (Poema.js)
β”‚   β”œβ”€β”€ routes/
β”‚   β”‚   β”œβ”€β”€ poemas/         # CRUD routes separated by action
β”‚   β”‚   └── index.js        # Main router
β”‚   β”œβ”€β”€ database.js         # MySQL connection with Sequelize
β”‚   └── app.js              # Express server
β”œβ”€β”€ .env                    # Environment variables (do not commit to GitHub)
β”œβ”€β”€ package.json            # Project dependencies
└── README.md               # Documentation

πŸ”Œ Initial Setup

  1. Clone this repository
  2. Make sure you have MySQL running and have created the poetisas database with the Poemas table
  3. Create a .env file in the project root with your connection credentials:
DB_NAME=poetisas
DB_USER=root
DB_PASS=your_password
DB_HOST=localhost
DB_DIALECT=mysql
PORT=3006
  1. Install dependencies:
npm install
  1. Start the server:
node src/app.js

πŸ“– Available Endpoints

Method Route Description
GET /poemas Retrieve all poems
GET /poemas/:id Retrieve a poem by ID
POST /poemas Create a new poem
PUT /poemas/:id Update an existing poem
DELETE /poemas/:id Delete a poem by ID

πŸ§ͺ Example POST /poemas Request

{
  "titulo": "Canto a la vida",
  "autora": "Gabriela Mistral",
  "pais": "Chile",
  "aΓ±o": 1938,
  "poema": "Vida, nada me debes, vida estamos en paz..."
}

πŸŽ₯ Project Explained on My YouTube Channel

This project was created step by step on my channel, where I teach programming, APIs, and web development with real and creative examples.
πŸ‘‰ @alienexplorer


🧠 Credits and Purpose

Created by @alienexplorer
Educational and cultural project to showcase works by Latin American women poets.
Inspired by the idea of building APIs with purpose and artistic sensitivity ✨


πŸ“œ License

This project is shared for educational and non-commercial purposes.
All poems are in the public domain or cited for educational purposes.

About

πŸ“š RESTful API for Latin American women poets' poems built with Node.js, Express, Sequelize and MySQL. Educational and cultural project to showcase the work of female poets from Latin America. ✨ Created for my YouTube channel alienexplorer

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published