ShoppingList is a simple API that allows users to record, share and keep track of their shopping lists.

• Users can create accounts.
• Users can log in.
• Users can create, view, update and delete shopping lists.
• Users can add, update, view or delete items in a shopping list

Documentation for the API can be found at https://shoppinglist12.docs.apiary.io/#

Tools used for development of this API are;

• Documentation : Apiary
• Database: Postgresql
• Microframework: Flask
• Editor: Vs code
• Programming language: Python 3.x.x
• API development environment: Postman

From the project's repository, to run tests, use

   python -m pytest tests/ 

1. Install requirements, run

     pip install -r requirements.txt

2. Database configuration.
   • Download and install postgres from here
   • Create database in terminal

      psql postgres;
      CREATE DATABASE database_name;

   • Connect the application to the database by changing the POSTGRES variable in shopping_list/app/init.py.

      POSTGRES = {
            'user': 'database user',
            'pw': 'user password',
            'db': 'database name',
            'host': 'localhost',
            'port': '5432',
            }
   

3. To create database tables, from the project's repository run

    $ python manage.py db init
    $ python manage.py db migrate
    $ python manage.py db upgrade
    $ python run.py runserver

URL: https://deployment-shopping-list-api.herokuapp.com/api