/PP-Flask_to_do_List_API

A simple flask API that is documented using Swagger and tested using Postman

Primary LanguagePython

A flask to do list API

This is a flask to do list API

Preview

GET request

image

Functionalities

  • Create task
  • View task/tasks
  • Update tasks
  • Delete tasks

Installation

Run this simple command: pip install -r requirements.txt

Getting started

  1. Clone the repository: git clone https://github.com/KayongoYongo/PP-Flask_to_do_List_API.git

If you are starting from scratch:

  • Create the database in SQL using the command CREATE DATABASE IF NOT EXISTS your_database_name;

  • Run the script createDatabase.py to create the tables by typing python createDatabase.py.

  • Navigate to the apps directory and run this command: python app.py

  • To run the website, copy this link onto the browser: http://127.0.0.1:5000/

If you want to use populated data, use the dump file provided:

To restore the dump file, use this command mysql -u username -p database_name < dump_file.sql