Skip to content

Latest commit

 

History

History
125 lines (69 loc) · 2.16 KB

README.md

File metadata and controls

125 lines (69 loc) · 2.16 KB
Raw

Spotter

Spotter is a Django web app that assists users in crowd-sourcing unconventional parking spots in urban areas.

Technologies Used:

Tech Stack:

Amazon AWS - RDS & S3

Python

Javascript

Django

Heroku

Libraries Used:

LeafletJS

MaterializeCSS

Material Icons

OpenCage Python Module

API's Used:

[OpenStreetMap] - Raster map tiles

OpenCage - Geosearch api

Getting Started:

A link to the deployed app (Heroku)

Planning Materials:

Trello: Trello Board ERD: Lucidchart ERD

Wireframes: Figma Package

Planned future enhancements (icebox items).

  • Set timeout feature, for when you can only park for X hours
  • Develop social features
    • Nested comments
    • Friends
    • Share spots between friends

Planning:

SET UP DEV ENVIRONMENT:

Clone:

git clone https://github.com/th3dougler/freepark.git

Requirements:

pipenv:

pip3 install pipenv
cd freepark
pipenv install

While working: Any new packages need to be added to the pipenv virtual environment:

instead of:
pip3 install xyzpackage

do this:
pipenv install xyzpackage

Branch:

Create new branch:

git checkout -b branchname

Work on existing branch:

git checkout branchname

Merge back into main:

git checkout main
git merge branchname
git push origin main

More Branching Stuff