API to read RSS Articales from a xml URL, that will expose the endpoints:
GET /api/articles
POST /api/articles/import
The second endpoint needs a query parameter ?siteRssUrl with a endpoint with a valid rss xml file.
A valid API call by example is:
POST {endpoint}/api/articles/import?siteRssUrl=https://www.lemonde.fr/rss/une.xml
git clone https://github.com/hipolito/studious-article-reader.gitcd studious-article-reader
npm installThis project used environment variables to be configure so, export the following variables pointed to your database and expected api port exposed
export DATABASE_PASSWORD='some_incredible_password'
export DATABASE_NAME='database_name'
export DATABASE_USER='root'
export DATABASE_PORT=3306
export DATABASE_HOST='localhost'
exprot SERVER_PORT=8080
export DATABASE_DIALECT='mysql'
I use .env file with this variables for my docker-compose.yml solution
In this project I used Sequelize ORM to create the interface between my models and the database, and in case mysql is used the database creation must be made previously running the sequelize commands
mysql -u root -p
create database studious_article_reader_db
After creating the database run the migrations to create the tables
npm run migrate:up
If needed, the database DDL init.sql can be executed run the script so after creating the database, just open the database and run the commands inside the file to create the structure
mysql -u root -p
create database studious_article_reader_db
exit
mysql -u root -p studious_article_reader_db < init.sql
To run the application
npm run start
If docker is used in your environment, please configure a .env in the root of this project:
DATABASE_PASSWORD='some_incredible_password'
DATABASE_NAME='studious_article_reader_db'
DATABASE_USER='root'
DATABASE_PORT=3306
DATABASE_HOST='localhost'
SERVER_PORT=8080
DATABASE_DIALECT='mysql'
docker-compose up
To functional tests I shared a postman collection with some examples and how to use the API
testArticlesApi.postman_collection.json