https://github.com/devilkiller-ag/microsoft-ambassador-project
A doubt sharing website for educational institutions where students can post their questions to be answered as soon as possible by their seniors and teachers who are experts in the field.
https://github.com/devilkiller-ag/microsoft-ambassador-project
expressjs reactjs tailwind-css tiptap-editor
Last synced: 6 months ago
JSON representation
A doubt sharing website for educational institutions where students can post their questions to be answered as soon as possible by their seniors and teachers who are experts in the field.
- Host: GitHub
- URL: https://github.com/devilkiller-ag/microsoft-ambassador-project
- Owner: devilkiller-ag
- License: cc0-1.0
- Created: 2023-08-17T15:48:33.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-08-17T15:57:49.000Z (almost 3 years ago)
- Last Synced: 2025-02-10T20:26:27.764Z (over 1 year ago)
- Topics: expressjs, reactjs, tailwind-css, tiptap-editor
- Language: JavaScript
- Homepage: https://askitout.vercel.app/
- Size: 9.98 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Microsoft Ambassador Project: AskItOut
AskItOut is a doubt sharing website for educational institutions where students can post their questions to be answered as soon as possible by their seniors and teachers who are experts in the field.
- The site is live [here](https://askitout.vercel.app/).
- The server is live [here](https://askitout-backend.onrender.com).
- The preview of figma design is available [here](https://www.figma.com/proto/u41aTTJzAxouyKXEdXxaDP/AskItOut-Design?page-id=0%3A1&type=design&node-id=40-196&viewport=388%2C204%2C0.3&scaling=scale-down&mode=design).
## Abstract
Students in India's primary and secondary schools frequently take tuition classes for a variety of reasons. India's education system is very competitive, and students are under a great deal of pressure to perform well on their examinations. The curriculum can be difficult, with an emphasis on memorization and rote learning. In many instances, parents believe that their children require additional assistance and support outside of the classroom to keep up with the curriculum's pace and to guarantee that the information is completely learned. In addition, some parents believe that the quality of education provided by their child's school is insufficient and that tuition classes might provide a more comprehensive education for their child.
Most students enrol in coaching since their questions are not answered in school and they cannot self-practice the concepts covered in class owing to a lack of assistance after class. After-school coaching increases children' workload, causes stress due to different topics covered at two places at the same time and different teaching methodology, and absorbs nearly their entire day. As a result, they are unable to self-research topics and generate interest in them, devote less time to physical activities, and are unable to investigate beyond the school/college curriculum. Students enrolling in coaching institutes reflects the inadequacy of the current education system, which does not prioritise students adequately.
We intend to create a platform that will enable educational institutions enhance their teaching approach by providing a doubts-solving-platform tailored to their course curriculum, where students can post their doubts and their seniors and teachers with relevant experience can answer them. We intend to create this platform so that points, levels, and tiers will encourage students and teachers to ask and resolve questions.
## Video Preview
https://github.com/devilkiller-ag/AskItOut/assets/43639341/4d4d79ca-f259-4bb6-9b88-88ef5072082d
## Features
- The text editor for writing questions and answers was developed using TipTap. It has various editing features like headings, text color, bold, italic, qoutes, code, subscript, subscript, strikeout, underline, link, unordered list, ordered list, images, and many more features will be added soon.
- User can flash, and share questions.
- User can upvote or downvote answers.
- Feature to detect and alert any unfilled field while posting questions, answers or signup.
- User can add tags to their question.
- User can delete questions and answers posted by them.
- User can view questions posted or saved by them.
- One answer among all answers posted for a question is marked as verified based on number of likes and dislikes.
- Users are awarded trophies for 'Advanced', 'Intermediate', and 'Beginner' based on number of questions asked and answered. This encourages students in school to positively compete with each other and get a gamified learning experience.
## Upcomming Features
- Password Reset and Remember Me Feature
- View questions based on categories on homepage
- Search Questions posted by other users
- Update Profile
- Edit questions and answers after posting them
- Save Questions
- Notification about latest questions and answers
- More robust algoirthm for user level, and for determining verified answer
- Explore Page having trending blogs and post
- Dark and Light Mode
- AI based doubt solver in premium subscription
## Techstack
### Web Design
- Figma
- User Avtars and Welcome Page Illustrations by [DrawKit](https://www.drawkit.com/).
- Icons by [HugeIcons](https://www.figma.com/file/sLyaPDH47I4mFaypraUjr1/168-Essential-Free-Icons-%7C-Hugeicons-Pro-%7C-10K%2B-Icons-(Community)?type=design&node-id=2%3A7&mode=design&t=w295KQ5K033NnWUp-1) and [React Icons](https://react-icons.github.io/react-icons/).
- Categories Icon from [Icons8](https://icons8.com/).
### Fronend
- HTML, CSS, JS
- React.js
- Node.js
- React Router
- Redux
- Tailwind CSS
- TipTap
- Copy To Clipboard
- React Toastify
### Backend
- Node.js
- Express.js
- Bycrypt js
- JWT
- Dotenv
- CORS
### Deployment and Storage
- Frontend: [Vercel](https://vercel.com/)
- Database: [MongoDB Atlas](https://www.mongodb.com/atlas/database)
- Backend: [Render](https://render.com/)
# Development Guide
## Available Scripts for Client
In the client directory, you can run:
### `npm run start`
Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
The page will reload when you make changes.\
You may also see any lint errors in the console.
## Available Scripts for Server
In the server directory, you can run:
### `npm run start`
Runs the app in the development mode.\
Open [http://localhost:5000](http://localhost:5000) to view it in your browser.
The page will reload when you make changes.\
You may also see any lint errors in the console.