Get Headlines automates XML/RSS feed parsing to JSON and exposes data via REST API.

Table of Contents

• Getting Started
  • Requirements
  • Development
  • Running the tests
• Contributing
• License

Getting Started

Requirements

• PostgreSQL

If you don't already have PostgreSQL installed, download and install it now.

--Create user
createuser --interactive

--Create database
createdb getheadlines_dev

--Set password for new user
ALTER USER YOUR_USER WITH ENCRYPTED PASSWORD 'YOUR_PASSWORD';

--Grant all privileges of the database to the user
GRANT ALL PRIVILEGES ON DATABASE getheadlines_dev TO YOUR_USER;

• Environment variables - rename .env.example to .env and update to fit your preferences

After everything is set, run script to create necessary tables and test data:

npm run init:db

Development

# Clone this repository
git clone https://github.com/cedevita/getheadlines.git

# Go into the repository
cd getheadlines

# Install dependencies
npm install

# Run the app
npm run dev

Running the tests

npm run test

Contributing

Contributions are always welcome! Please read the contribution guidelines first.

• Contributing guide
• Code of Conduct

License

Get Headlines is MIT licensed.