m-romberg/pixly-backend

Pix.ly Backend

Pix.ly is a RESTful API for images and their metadata, leveraging bucket storage in AWS for all image uploads. Can be used with Pix.ly frontend for a full image gallery and soon to be image editing platform.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Pix.ly is a RESTful API for images and their metadata, leveraging bucket storage in AWS for all image uploads. Can be used with Pix.ly frontend for a full image gallery and soon to be image editing platform.

(back to top)

Built With

• 
• 
• 

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

• python3
• postgresql
• aws

Installation

1. Set up an AWS Bucket at https://aws.amazon.com/s3/
2. Clone the repo

   git clone https://github.com/m-romberg/pixly-backend.git

3. Install pip3 packages

    python3 -m venv venv
    source venv/bin/activate
   
    pip3 install -r requirements.txt

4. Enter your AWS bucket in app.py

   AWS_BUCKET_URL = "https://madelynromberg-pixly.s3.us-west-1.amazonaws.com"

5. Create database in postgresql

   psql createdb pixly

6. Change databse link in app.py

  app.config['SQLALCHEMY_DATABASE_URI'] = os.environ.get(
  "DATABASE_URL", 'postgresql:///pixly')  # must link to db

7. Run seed.py

  python3 seed.py

8. Run app in shell

  flask run

(back to top)

Usage

Please refer to the Demo

(back to top)

Roadmap

• Add photo editing feature using Pillow
• Allow users to revert edited photos

(back to top)

Contact

Madelyn Romberg - - madelyn@madelynromberg.com

Project Link: https://github.com/m-romberg/pixly-backend

(back to top)

Acknowledgments

• Sarah Graup

(back to top)