Code Monkey home page Code Monkey logo

dashboard's Introduction

AllyArc - (Dashboard)

Project Description

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.

What you need

To run this repo you will need to have:

Firebase Setup

  1. Create a firebase project
  2. Create a firestore database with three collections, namely: student(1), question(2), answer(3)
  3. Fill in with temparory values as you create a starting document for each collection with the following fields
  4. 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.js with that of your project credentials.

How to run

Clone the repo and change into the new directory:

git clone https://github.com/AllyArc/AllyArc-Dashboard.git
cd AllyArc-Dashboard

Install the dependencies:

npm install

With all that prepared, start the application with:

npm start

dashboard's People

Contributors

zainab-fahim avatar

dashboard's Issues

Create Dashboard Authentication

Use Firebase to create authentication, where only restricted access to the dashboard is given. If the user is in the auth_dashboard_users collection, only then access is allowed to the dashboard

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.