Skip to content

singram11/packing-app

Repository files navigation

PackMe - Packing App

PackMe is an application that allows users to create, modify and store a variety of packing lists all in one place so they can reuse them each time they take a trip. It also allows users to associate specific gear they own with the items on their list so that they can track the details of the gear they have as well as make their lists specific to whatever type of adventure they want to go on.

🌲 Contents

🌲 Features


User registration and login:




Add and Edit Lists and Items:




Select and Add Gear:




View Gear Details:




🌲 Technologies & Stack

Backend: Python, Flask, SQLAlchemy, PostgreSQL
FrontEnd: React, Javascript, Babel, ReactRouter, ReactBootstrap, HTML, CSS
API's: Cloudinary

🌲 Set-Up and Installation

Requirements


You must have installed:
  • PostgrSQL
  • Python3
  • Flask
  • FlaskSQLAlchemy
  • Cloundinary

You will also need (included via CDN in app.html):

  • React
  • ReactRouter
  • ReactBootstrap

How to install


Install Python3
Install pip, the package installer for Python
Install postgreSQL for the relational database.

Clone or fork the repository:

$ git clone https://github.com/singram11/packing-app.git

Create and activate a virtual environment within the project directory:

$ virtualenv env
$ source env/bin/activate

Install dependencies:

$ pip3 install -r requirements.txt

Make an account with Cloudinary & get your API key.

You will also need to create your own Flask Session key.

Both the Cloudinary and Flask Session keys should be stored in a secrets.sh file.

export FLASK_SECRET_KEY="yourKeyHere"

export CLOUDINARY_KEY="yourCloudinaryKeyHere"
export CLOUDINARY_SECRET="yourCloudinarySecretHere"

Load the variables from your secrets.sh into your shell:

$ source secrets.sh

With PostgreSQL installed create a database to store the user information:

$ createdb packme

If you want some test users and sample data you can run the seed_database.py file:

$ python3 seed_database.py

Note: this will drop the database and recreate it with the demo information - once you have data in your DB you will not want to run this unless you want to clear the DB.

Then run the server from the command line:

$ python3 server.py

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors