FAQzy

Gettings Started

This contains all of our solution's source code. The project is a mono repo, which means that all of the code is in one repository. This makes managing dependencies and sharing code between different project parts easier.

---

See Demo

Explore the ./Demo folder to preview the solution in action. We recommend watching the demo once to better understand the project's workflows and features.

---

Directory Structure

faqzy/
│
├── Demo/                     # Demo files showcasing the project
│   ├── demo_video.mp4
│   └── demo_images/
│
│
├── src/
│   ├── client/                # Frontend Flutter application
│   └── server/                # Backend Django application
│
├── Presentation.pptx          # Presentation of our Solution
├── test/                      # Contains larger datasets and tests to
│                              # test the performance of the system
│
├── Dockerfile                 # Dockerfile for containerizing the project
├── README.md                  # Project overview and setup instructions
└── .gitignore                 # Files and directories to ignore in Git

---

How to Run this yourself (locally)

Clone the repository onto your local machine

git clone https://github.com/sudo-boo/faqzy.git

Frontend

The frontend is currently displayed and used as an application but can be deployed for web too since we use flutter..!!

For now, to test it for,

Android: Just install the .apk file provided in the Releases section of the repository. Otherwise, you can follow the same steps given below to build and install it for Android too.

iOS: If you want to test it for iOS, cd to the client source code folder

cd faqzy/src/client/

Connect your iPhone or iOS emulator, build and install it using

flutter install

Note: The server address by default is set to localhost:8000. You might want to change that and rebuild.

Backend

To run the backend, cd to the server source code folder

cd faqzy/src/server/

Create a virtual environment and turn it on

python -m venv .
./Scripts/activate

Now install all the dependencies using pip. (You just have to do these steps only for the first time)

pip install -r requirements.txt

Run the server

python -m makemigrations
python -m migrate
python -m runserver