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

---

.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 it'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 it's detailed documentation over here

---

Getting Started

Refer here for the installation instructions