Skip to content

Home food management application (pantry of ingredients, recipes, meal planning)

Notifications You must be signed in to change notification settings

shamsow/django-react-homemaker

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

72 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

LinkedIn GitHub issues


Logo

HomeMaker

One stop solution for home groceries tracking, recipe collecting and meal planning


View Full Demo · Report Bug · Suggest Feature

Project Demo

Table of Contents

  1. About The Project
  2. Getting Started
  3. Roadmap
  4. License

About The Project

The motivation behind this project was to create a sophisticated application which requires in-depth planning to execute. This is without a doubt the most ambitious project I've done so far.
When I set out to build this app I only had basic knowledge of React, and learning by doing proved to be the best way to pick up React fast.

Built With

Implementation details

This project utilizes a django backend and a React frontend.

The django backend is implemented as a REST API using django-rest-framework. The react frontend uses react-router-dom for routing. Additionally, I heavily used material-ui for React components and design inspiration.

Authentication is achieved using JWT.

All forms have error highlighting with relevant messages,

Error highlighting

This is achieved by response from the API, not checked manually using JavaScript.

Getting Started

To get a local copy up and running follow these steps.

Prerequisites

  • npm
    npm install npm@latest -g
  • pip
     python -m pip install --upgrade pip

Installation

  1. Clone the repo
    git clone https://github.com/shamsow/django-react-homemaker.git
  2. Install NPM packages
    cd react/homemakerapi
    npm install
  3. Install pip packages
    cd django
    pip install -r requirements.txt

Start

  • Backend
    cd django
    python manage.py migrate
    python manage.py runserver
  • Frontend
    cd react/homemakerapi
    npm start

Roadmap

See the open issues for a list of proposed features (and known issues).

License

Distributed under the MIT License.

About

Home food management application (pantry of ingredients, recipes, meal planning)

Resources

Stars

Watchers

Forks