Flask CRUD API

This is a simple Flask application that demonstrates CRUD (Create, Read, Update, Delete) operations using a PostgreSQL database. The application allows you to manage quotes by inserting, updating, deleting, and retrieving quotes.

Prerequisites

Before running the application, make sure you have the following installed:

• Python (version 3.6 or higher)
• pip package manager
• PostgreSQL (with a running database server)

| NOTE: Postgres installation on docker-compose reference: https://github.com/khezen/compose-postgres/blob/master/docker-compose.yml

Getting Started

To get started with the application, follow these steps:

1. Clone the repository:

   $ git clone https://github.com/your-username/flask-crud-application.git
   

2. Navigate to the project directory:

   $ cd flask-crud-application

3. Install the required dependencies:

   $ pip install -r requirements.txt
   

4. Setup database

   • Create a PostgreSQL database for the application.
   • Update the database connection URI in .env file to match your PostgreSQL configuration. The URI should be of the format: postgresql://username:password@hostname:port/database_name
   • Example .env content:

   FLASK_APP=app
   FLASK_DEBUG=False
   DATABASE_URL=postgresql://username:password@hostname:port/quotes_flask_curd

5. Run Application:

   flask run

6. Access the Application The Flask application will be running on http://localhost:5000. Open this URL in your web browser to access the application.

Usage

The application provides the following routes for managing quotes:

• / - Retrieves all quotes from the database.
• /random - Retrieves a random motivational quote from an external API.
• /insert - Inserts a new quote into the database.
• /update - Updates an existing quote in the database.
• /delete/{id}/ - Deletes a quote from the database by ID.

To interact with the application, you can use tools like Postman or cURL to send HTTP requests to the respective routes.

Contributing

Contributions are welcome! If you find any issues with the application or have suggestions for improvements, please feel free to submit an issue or a pull request.