README.md

Teacher's Aid 🧾

Teacher's Aid is a web-application that allows teachers to create questions using natural language processing and save those questions to review at any time. The application uses modern frontend and backed development tools. The application handles calendar, database queries and nlp to create the questions.

Built With 🛠

• Express JS - Express JS Express is a minimal and flexible Node.js web application framework that provides a robust set of features for web and mobile applications.

• NodeJS - Node.js is an open-source, cross-platform, back-end JavaScript runtime environment.

• Cohere AI - Cohere provides access to advanced Large Language Models and NLP tools through one easy-to-use API.

• Firebase - Firebase is a product of Google which helps developers to build, manage, and grow their apps easily.

• Docker - Docker is a set of platform as a service products that use OS-level virtualization to deliver software in packages called containers.

• Vercel - Vercel is a cloud platform as a service company which hosts and deploys apps.

How to run the project?

1. Using Docker 🐳 (Only Client Side)

📌 Pre-requisites

• docker
• docker-compose (which usually comes along with docker but if it's not the case then yeah)

📌 Steps

• Clone the repository using git clone https://github.com/HenokB/Teacher-Aid.git
• Navigate to the client cd client
• Create an empty firebase project and get all the keys and add them in the firebase.js file.
• Run docker-compose up
• Now it will start running and you can go to http://localhost:3000/ from your browser and it would render dev tools in your browser.

2 Using NPM or YARN 📦

• git clone https://github.com/HenokB/Teacher-Aid.git

• navigate to the client folder using cd client

• Create an empty firebase project and get all the keys and add them in the firebase.js file.

• run npm start, it will start running and you can go to http://localhost:3000/

For the backend🔌

1. Make sure you are in the root directory.
2. Go to cohere.ai and get an API key. Put it inside the server/index.js file.
3. Install all the dependencies using yarn install or npm i
4. Run npm start or yarn start in the root dir. This will launch the backend in localhost:3001

⚠️ Don't forget to Run both the client and server at the same time in two different terminals.

Screenshots 📸

Laning page

Question generation

Save questions

Sharing questions

Calendar

© 2022 Henok Ademtew ☕️