Code Monkey home page Code Monkey logo

outfitless's Introduction

Outfitless ๐Ÿ‘•๐Ÿ‘—๐Ÿ‘–๐Ÿ‘š

Outfitless helps users organize their closet, choose outfits, and keep track of their clothes. Most notably, it keeps track of the cost per use for each piece of clothing.

Inspired by the trend towards zero waste, capsule wardrobes, and Mari Kondo of โ€œThe Life-Changing Magic of Tidying Upโ€, Outfitless hopes that its users will learn to do more with less.

Table of Contents ๐Ÿ“‘

Tech Stack ๐Ÿ’ป

Frontend: HTML5, CSS, Javascript, jQuery, Bootstrap
Backend: Python, SQL, Flask, PostgresQL, SQLAlchemy
APIs: Google OAuth 2.0, Clarifai

Deployed via Amazon Web Services LightSail

Features โœจ

See the app in action here:
Outfitless demo

Register & log in via Google.

Login

Upload multiple files at once.

Upload

Verify suggested piece details, or write in your own description.

Verify Verify2

Choose an outfit with OOTD feature!

OOTD

Check out all pieces uploaded to closet, and their details.

Closet

Please note that although the site is live, these features will only work if you install the app locally. Everything past log-in has been disabled from the site.

Setup/installation ๐Ÿ› 

Requirements:

  • Python 3+
  • PostgresQL
  • Google OAuth 2.0 keys ๐Ÿ”‘
  • Clarifai API keys ๐Ÿ”‘
  • SSL certificate & key ๐Ÿ”–๐Ÿ”‘

To run this app on your local computer, please follow the below steps:

Clone repository.

$ git clone https://github.com/janetanne/outfitless.git

Create and activate a virtual environment.

$ virtualenv env
$ source env/bin/activate

Install the dependencies:

$ pip install -r requirements.txt

Sign up to use the Google OAuth API and Clarifai API. Obtain your secret keys ๐Ÿ”‘, then save them to secrets.sh. The file should look like this:

export APP_SECRET_KEY="insert"
export CLARIFAI_API_KEY="keys"


export GOOGLE_CLIENT_ID="andotherstuff"
export GOOGLE_PROJECT_ID="here"
export GOOGLE_AUTH_URI="https://accounts.google.com/o/oauth2/auth"
export GOOGLE_TOKEN_URI="https://www.googleapis.com/oauth2/v3/token"
export GOOGLE_AUTH_PROVIDER="https://www.googleapis.com/oauth2/v1/certs"
export GOOGLE_CLIENT_SECRET="linksaboveshouldworkthough"

Source your keys from secrets.sh into your virtual environment.

$ source secrets.sh

Note that you'll also need to procure an SSL certificate if you want to deploy since Google OAuth 2.0 requires HTTPS. You can learn more about that and obtain your own SSL cert for free on Let's Encrypt.

Set up your database.

$ createdb outfitless_db
$ python model.py

Run the app from the command line.

$ python server.py

Navigate to 'localhost:5000/' to access Outfitless.

Future Features ๐Ÿ”ฎ

  • Generate proper SSL certificate
  • Data visualization of user's closets, using Chart.js
  • Reminders to wear, donate, or sell clothes not worn in a certain period of time
  • Upload photos to Google Photos

About the Developer ๐Ÿ‘ฉ๐Ÿปโ€๐Ÿ’ป

This was created by Janet Anne Panen for her final project at Hackbright Academy, an engineering school for women.

She's located in San Francisco, and you can contact her via Twitter, LinkedIn, or email ๐Ÿ“ง janetpanen at gmail dot com.

This project was inspired by the annoyance of choosing what to wear every day, and the 90s classic film, Clueless (hence the name Outfitless ๐Ÿ˜‰).

License ๐Ÿ“

The MIT License (MIT) Copyright (c) 2016 Agne Klimaite

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

outfitless's People

Stargazers

Bo Price avatar AlsoAHuman avatar tg-z avatar Daniel Yang avatar Kris avatar

Watchers

James Cloos avatar

Forkers

codercarrot

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.