Skip to content

SincerelyBrittany/newsAPI

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

24 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation


My First Ruby API Project

An API that helps the user search and retrieve live articles from all over the web.
Explore the docs »

View My Demo · Report Bug/Request A Feature · View my Blog

Table of Contents

About my Project

The project allows a user to display a list of the Top U.S. stories/articles and receive more information on each story.

In addition, it allows a user to search by query for articles in relation to the user input.

Built With

Getting Started

To get a local copy up and running follow these simple installation steps.

And then execute:

  $ bin/newsApp

Installation

  1. Get a free API Key at https://newsapi.org/
  2. Clone the repo
git clone https://github.com/<your_username>/newsAPI
  1. Install gem packages
bundle install
  1. Enter your API in api_manager.rb
const API_KEY = 'ENTER YOUR API';

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Bug reports and pull requests are welcome on GitHub at https://github.com/SincerelyBrittany/newsAPI. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

Distributed under the MIT License. See LICENSE MIT License for more information.

Contact

Twitter: @SincerelyBrittt
Email Me
Project Link: newsAPI
Connect with me on LinkedIn
Follow me on Medium

Acknowledgements

About

No description, website, or topics provided.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published