AllyArc is an all-you-need teacher's assistant, automating answering students' queries while providing concise progress of the student in a simple dashboard. Aimed to help the management of a SEN classroom, AllyArc is both a culmination of a WhatsApp chat bot, and a business dashboard.
On one hand the chatbot intelligently communicates with your students, answering queries as well as tracking student skill while sending assigned assignment questions. While on the other hand, the dashboard displays the received information regarding answer details, and many other student skill related data, as well as perform many other functionalities.
The application on the frontend is built using React.js which uses the CoreUI library to construct the dashboard, while integrating many Firebase products such as Firestore (database), Hosting (deployment), and Extensions (Twilio). Twilio (which is used to build the chatbot) itself is an incorporation of many services such as Autopilot (NLP), Functions and WhatsApp messaging API. Lastly the application also has a CI/CD pipeline which is handled by GitHub actions.
Note: The following installation focuses on running the frontend of the application. Click here to checkout the process to run the chatbot.
To run this repo you will need to have:
- Create a firebase project
- Create a firestore database with three collections, namely:
student(1),question(2),answer(3) - Fill in with temparory values as you create a starting document for each collection with the following fields
- Get the firebase credentials for the specifics of your project from the project settings (you will find it at the end of the page, with npm selected as your SDK setup), and replace the contents of
supaut-dashboard/src/firebase.jswith that of your project credentials.
Clone the repo and change into the new directory:
git clone https://github.com/AllyArc/AllyArc-Dashboard.git
cd AllyArc-DashboardInstall the dependencies:
npm installWith all that prepared, start the application with:
npm start