README

Après-Ski App

Report Bug · Request Feature

Hungry and tired after a day at Breckenridge? Looking to find somewhere that's fun, good vibes, and close enough to walk?

Find it with Après-Ski!

The web application geared towards snowsport enthusiasts looking to find their post slopes food & drinks to round out a good day.

Getting Started

Web Usage

This is a Django REST Framework API designed for a use with our Front-End Team's React web application. To get started in the application, follow this link and select one of our test-users. Once you selected a user you will be able to:

Browse a list of restaurants near you based on:
- Vibe
- Proximity to the user
Select "Filter" to narrow down the list of restaurants based on:
- Vibe
- Alcohol
- Happy Hour
Select "Show Details" on a restaurant to see further information such as:
- Address
- Food Type
- Alcohol
- Cost
- Hours
- Happy Hour
Select a restaurant marker on the map to automatically scroll to that restaurant

Local Installation

This back-end application was made with the following:

Python 3.11.1
Django 4.1.6

To install and run on your personal computer you will need to do the following:

Get a free API Key for Geoapify's Routing-API at Geoapify.
Fork and clone the repo to your local machine.
In the root directory of APRES_SKI_BE, create a file named keys.py.
Inside keys.py create a variable named routing_key = 'your_key_as_string'
- Note: keys.py should be grayed out. If it is not, check the .gitignore and resolve the issue before pushing any changes.
Install requirements.
```
pip3 install -r requirements.txt
```

Migrate and seed database.

$ python3 manage.py migrate
$ python3 manage.py loaddata user.json
$ python3 manage.py loaddata restaurant.json
$ python3 manage.py loaddata engagement.json
$ python3 manage.py loaddata hour.json
$ python3 manage.py loaddata happyhour.json
$ python3 manage.py loaddata lift.json
$ python3 manage.py loaddata comment.json
$ python3 manage.py loaddata photo.json

Start a server.
```
python3 manage.py runserver
```
Navigate to http://localhost:8000/api/v1/

API Endpoints

Below is a short list of the endpoints used by the front-end web app. For a full list of all endpoints please use this_link

GET

localhost:8000/api/v1/restaurant

Description

Get a list of restaurants.

Parameters

N/A

Response

200 OK

{
  "data": [
    {
      "type": "str",
      "id": "int",
      "attributes": {
          "name": "str",
          "address": "str",
          "food_type": "str",
          "cost": "str",
          "cover_img": "str",
          "alt_text": "str",
          "lat": "str",
          "lon": "str",
          "alcoholic_drinks": "bool",
          "has_happy_hour": "bool",
          "hour": [
            {
              "id": "int",
              "sunday": "str",
              "monday": "str",
              "tuesday": "str",
              "wednesday": "str",
              "thursday": "str",
              "friday": "str",
              "saturday": "str",
              "restaurant": "int (id)"
            }
          ],
          "happyhour": [
            {
              "id": "int",
              "sunday": "str",
              "monday": "str",
              "tuesday": "str",
              "wednesday": "str",
              "thursday": "str",
              "friday": "str",
              "saturday": "str",
              "special": "str",
              "restaurant": "int (id)"
            }
          ],
          "engagement": [
            {
              "id": "int",
              "vibe": "str",
              "rating": "str",
              "favorites": "bool",
              "restaurant": "int",
              "user": "int"
            }
          ],
          "photo": [
             {
               "id": "int",
               "url": "str",
               "alt_text": "str",
               "restaurant": "int"
             }
           ]
        }
     },
     {"..."}
   ]
}

404 Not Found

{
  "errors": [
    {
      "detail": "Not found.",
      "status": "404",
      "code": "not_found"
    }
   ]
}

Notes

hour, happyhour, and engagement will return empty arrays if there is no associated table for the given restaurant.

localhost:8000/api/v1/user

Description

Get a list of users.

Parameters

N/A

Response

200 OK

{
 "data": [
    	{
  		"type": "str",
  		"id": "int",
  		"attributes": {
  			  "name": "str",
  			  "lat": "str",
  			  "lon": "str",
      }
    },
    {"..."}
    ]
}

404 Not Found

{
  "errors": [
    {
      "detail": "Not found.",
      "status": "404",
      "code": "not_found"
    }
   ]
}

localhost:8000/api/v1/lift

Description

Get a list of lifts.

Parameters

N/A

Response

200 OK

{
  "data": [
  	{
  		"type": "str",
  		"id": "int",
  		"attributes": {
  			  "name": "str",
  			  "lat": "str",
  			  "lon": "str",
     }
      },
      {"..."}
    ]
}

404 Not Found

{
  "errors": [
    {
      "detail": "Not found.",
      "status": "404",
      "code": "not_found"
    }
   ]
}

Project Overview

Learning Goals

The Back-End Team's learning goals were:

Gain exposure and experience to Python and Django REST Framework.
Implement Agile work process throughout development.
Use Service Oriented Architecture concepts.
Practice professional git workflow and pull request reviews.
Implement Continuous integrations.
Further hone communicational skills with a Front-End Team by doing daily stand-ups and slack networking.

Planning

The first four days of our project was dedicated to planning. In this time our Front-End and Back-End Teams were assigned to a student created project pitch and began work:

Day 1: Teams discussed any human factors and personnel limitations over the duration of the project, started work on a Minimal Viable Product Document, and created all infrastructure (GitHub: Organization, Repositories, Teams, & Projectboard).
Day 2: Teams discussed any capabilities and limitations in their selected tech-stack and finalized selection of what data would be collected, stored, and consumed.
Day 3: Teams completed the Minimal Viable Product Document
Day 4: Back-End Team created a small-scale test database and API as a proof of concept for approval by the Front-End Team and finalized the JSON Contract Document.

Tech Stack

Après-Ski's Back-end is a Django REST Framework API, built with Python & PostgreSQL, and hosted onHeroku.

Minimum Viable Product (MVP) and Extensions Roadmap

MVP

The Back-End Teams's MVP goals were to design, create, and deploy all requested endpoints for our Front-End Team to consume and display. For this we started with a PostgreSQL database and the following tables:

User
Restaurant
HappyHour
Hour
Lift
Engagement

Each table stored real data on various restaurants and lifts in Breckinridge Colorado. Information was gathered through various travel and restaurant websites and then turned into seed files, which we used to populate our database.

After our database was setup we created the above endpoints (see: API Endpoints), as requested by our Front-End Team, in accordance with the json:api standard.

All MVP goals were met. Testing for our API is at 99% coverage.

Extensions

The Back-End Team's Extension goals were to:

Create an external API call to Geoapify for /routing & /landmark endpoints.
- This was completed for /routing. However it was decided that other extensions should be prioritized due to time constraints.
- The /routing endpoint is not on our deployed site as it is not used by the Après-Ski webapp.
Create two new tables: Photo & Comment

All extensions (except the /landmark endpoint) were completed and tested. Below is the final version of our database tables and relationships.

Future features we would like to implement for our API:

Create another external API call to Geoapify to collect information on local landmarks.
Use Django REST Framework's TokenAuthentication class to implement authentication for any CREATE, POST, or PATCH requests.

Collaborators

Joseph Hilby

My goal in this project was to step out of my comfort zone with Ruby on Rails and try out a new language and framework. While it made the project considerably harder, I really enjoyed digging through the docs of a new tech-stack and seeing just how quickly I could bring myself up-to-speed.

I am extremely happy that we were able to get 99% testing coverage, on 8 tables, each with full CRUD functionality, in a new language & framework, all in two weeks.

Kristen Nestler

When I pitched the idea for Après-Ski, I was excited to combine my passions for skiing with my love for software engineering. I proposed using Python and Django for the backend, and Javascript and React for the front end so our team could gain more experience with learning new technologies.

Après-Ski delivered on all fronts. It was a great experience working with a true full-stack team to bring this application to life. I gained new strategies to quickly learn unfamiliar tech stacks and used these technologies in combination with a full SDLC to successfully and efficiently build our Après-Ski application.

Kevin Ta

Being apart of the Apres-Ski team, I had a personal goal of wanting to get first hand experience being a part of a Service Oriented Architecture application. This came with side goals of further developing proper communicational skills and collaboration with the Front-End team. During my course at Turing School of Software and Design, my experience was focused on Ruby and Ruby on Rails, so choosing to develop our Apres-Ski Application in Python was also an exposure to another language I further wish to continue exploring!

Contributing

Do you have a better & cooler way of doing what we did? Your contribution would be greatly appreciated.

Please fork the repo, create your branch, and create a pull request. You can also simply open an issue with the tag "enhancement".

Fork the Project
Create your Feature Branch (git checkout -b feature/<AmazingFeature>)
Commit your Changes (git commit -m 'Add some AmazingFeature')
Push to the Branch (git push origin feature/<AmazingFeature>)
Open a Pull Request

Thanks again!

Acknowledgments

Special thank you!, for your insight and help, as we designed and built an API in a totally new language and framework:

Thank you Tricia Holmes on our Front-End Team for your PR setting up CORS!

This project was the capstone for our team at:

Turing School of Software Design

(back to top)

Name		Name	Last commit message	Last commit date
Latest commit History 259 Commits
.github		.github
Apres_Ski_API		Apres_Ski_API
Apres_Ski_BE		Apres_Ski_BE
assets		assets
staticfiles		staticfiles
tests		tests
.gitignore		.gitignore
Procfile		Procfile
README.md		README.md
manage.py		manage.py
pytest.ini		pytest.ini
requirements.txt		requirements.txt

Apres-Ski/Apres_Ski_BE

Folders and files

Latest commit

History

Repository files navigation

README

Après-Ski App Report Bug · Request Feature

Table of Contents

Getting Started

Web Usage

Local Installation

API Endpoints

GET

200 OK

404 Not Found

200 OK

404 Not Found

200 OK

404 Not Found

Project Overview

Learning Goals

Planning

Tech Stack

Minimum Viable Product (MVP) and Extensions Roadmap

Collaborators

Contributing

Acknowledgments

About

Topics

Resources

Stars

Watchers

Forks

Languages

Après-Ski App

Report Bug · Request Feature