/ContentfullDemo

🚀 POC to get data from Content Delivery API

Primary LanguageRubyGNU General Public License v3.0GPL-3.0

Contentfull Demo - Contentful Content Delivery API Provider Data Preview

Grab the data from Contentful and display that on one page.

Live example

Generate creative GitHub profile readmes in few click!

🚀 Getting started

Instructions for local deployment are given below:

  1. Clone the repository
git clone https://github.com/AjayBarot/ContentfullDemo.git
  1. Enter the project directory
cd ContentfullDemo
  1. Install dependencies
$ bundle install
$ yarn install
  1. Set contentful API credentials(make sure you have master.key)
$ rails credentials:edit
  1. Database setup
$ rake db:setup
  1. Start local dev server
$ foreman s
  * Running on http://localhost:5000/
  1. Now open a browser and visit http://localhost:5000/.

🧐 Task list

  • Load Jquery with webpack
  • Play with API and check the response
  • Usage of contentful gem
  • View data on UI
  • Internalization of view part
  • Webpack Production Tweaks for heroku
  • Deploy the application on heroku
  • Documentation of the project
  • Add swagger for Open mobile API documentation
  • Add Rspec with VCR to test the API and response
  • Pagination
  • Research on contentful_model
  • We have to set webhook for caching mechanims from contentful side

💫 References

❤️ Supporting the project

A simple star to this project repo is enough to keep me motivated on this project for days. If you find your self very much excited with this project.

Thanks!

Contributions are welcomed!