Skip to content

kidfromjupiter/taste

Repository files navigation

Backend

Getting started

  • Install all python packages using pip install -r requirements.txt
  • After installing a new package, make sure to update the requirements.txt file using pip freeze > requirements.txt to make development easier for others
  • Run the backend using python manage.py runserver

API

  • All API endpoints should start with /api/
  • All API endpoints should be designed in insomia (or postman idc. haven't figured out all the details yet) and exported to a yaml file for documentation
  • All API views should have a tests
    • See DRF docs
    • Each endpoint should have a seperate file in backend/tests/ with the same name as the view
  • All API serializers should be hyperlinkedmodelserializers

Apps

  • Major components such as accounts, products, etc. should be in their own app
  • All apps should be in the apps directory
  • Each app should have a api.py file to contain the api endpoints of the app

Linking everything up

  • Import all the api endpoints from each app from the app's directory and add them to the urlpatterns in taste_backend/urls.py

Frontend

Getting started

  1. install all the dependencies using npm install or yarn install
  2. run dev server using npm run dev or yarn dev

Pages currently finished

design is finalised. All UI elements work as intended in the frontend.

  • Explore
  • Orders
  • Cart

Pages almost finished

design is not finalised but most UI elements work. So... usable but not pretty?

  • account edit page
  • home

Pages I have no idea what to do about

  • Collections (might remove after)
  • Grocery list

To do

Link up APIs

  • Search
  • add item to cart
  • remove item from cart
  • increase quantity of item in cart
  • decrease quantity of item in cart

pages to implement

  • Product page
  • product not found pages

Releases

No releases published

Packages

No packages published