https://github.com/ladrua/django-oscar-api-vue-storefront

API layer for django-oscar to vue-storefront
https://github.com/ladrua/django-oscar-api-vue-storefront

Last synced: 4 days ago
JSON representation

API layer for django-oscar to vue-storefront

• Host: GitHub
• URL: https://github.com/ladrua/django-oscar-api-vue-storefront
• Owner: ladrua
• License: other
• Created: 2018-12-09T03:36:55.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2018-12-23T06:33:23.000Z (almost 6 years ago)
• Last Synced: 2024-05-22T18:31:33.232Z (6 months ago)
• Language: Python
• Size: 60.5 KB
• Stars: 18
• Watchers: 8
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

• awesome-vuestorefront - Django Oscar API layer - oscar to vue-storefront (Resources for Vue Storefront 1 / Official Resources - v1)

README

        
===================================

Django Oscar API for Vue-Storefront

===================================

This package provides a RESTful API for `django-oscar `_ adapted to `vue-storefront `_.

Usage

=====

Still under development, no release yet.

Notes

=====

`Documentation `_ we are following for the api.

`Better definition of required fields `_

`Data Definitions `_

Developing

==========

1. To start using ``git clone`` then cd into directory and run ``pip install -e .``

2. Add ``oscar_vue_api`` to INSTALLED_APPS:

::

   INSTALLED_APPS = [

       ....

       'rest_framework',

       'corsheaders',

       'oscar_vue_api',

   ]

   MIDDLEWARE = (

       'corsheaders.middleware.CorsMiddleware',

       #...

   )

   CORS_ORIGIN_ALLOW_ALL = True

   REST_FRAMEWORK = {

    'DEFAULT_AUTHENTICATION_CLASSES': (

        ....

        'oscar_vue_api.authentication.TokenAuthSupportQueryString',

    )

   }

3. Import the api urls to your projects ``urls.py`` file:

::

   from oscar_vue_api.app import application as api

   urlpatterns = [

       ....

       url(r'^vsbridge/', api.urls),

   ]

Notes

=====

Export exsisting categories and products to elasticsearch: ``./manage.py oav_export``

Delete all ElasticSearch entries ``curl -X DELETE 'http://localhost:9200/_all'``