Documentation

Eatit Documentation

This wiki lays out a detailed documentation for the eatit project.

The eatit project's structure is as below:

.
├── .github                 # GitHub files (MD files, templates, workflows)
├── backend                 # Backend files (Django code)
├── frontend                # Frontend files (React JS code)
├── LICENSE
└── README.md

---

Basic Overview

React JS is used in the frontend. Main functionality of React is to just retrieve/submit the data from/to the backend respectively, and then displaying that data to the end user. The retrieving/submitting the data is achieved by making API calls to the backend's endpoints.
Django (Rest Framework) is used in the backend. Django defines various API routes in the backend and then appropriate view functions for them.
Authentication with React in frontend and Django in backend, is achieved using JSON Web Tokens.
Detailed docs is available below

---

Project Parent Folders

.github

This is a conventional folder used to place GitHub related stuff inside it.
The folder contains Markdown files, Issues templates, and a workflows folder for GitHub Actions

backend

This folder contains all the backend files i.e. the Django project.
We have a separate section dedicated to backend's detailed documentation over here

frontend

This folder contains all the frontend files i.e. the React JS project.
We have a separate section dedicated to frontend's detailed documentation over here