# ACS Doubts by Ronon

This document outlines the details and the features of the "ACS Doubts" project we've been working on. While this has been quite an exciting journey for the two of us, it was not without challenges and hurdles. But thanks to hard work and dedication we put into this, we believe the application is in a decent shape at the moment.

The project consists of two different applications.
1. The main ACS Doubts website
2. An administrative website

## The Main ACS Doubts Website

This website is for the consumers(students and solvers). Students will be able to post questions, and solvers will submit solutions to those questions. Here are some of the key features:
1. **Hassle free login system:** A student can log in just with his access code.
1. **User profiles and activities:** Each user, solver or a student will have their dedicated profile pages. Their profile pages will include their DPs, as well as their recent activities on the website.
1. **Extensive filtering support:** Questions can be searched by text, as well as filtered by subjects, books, chapters etc.
1. **Organized and intuitive:** Solutions and comments live in two different places, both in the UI and in the database, making it easier to access and maintain.
1. **Notification system**: Students and solvers will get notifications on relevant events. Like a student gets notified when his question gets solved or a solver gets notified when a student requires more clarifications.
1. **Great UI and UX**: This website looks and feels modern, intuitive and fast. It has dark mode too!
1. **Responsive**: The website works and looks great on devices of all screensizes.
1. **Image compression**: Sometimes the users upload images of huge sizes. So we took some extra measures to resize them down to a tolerable limit, as well as compress them to lower the toll on the server and to ensure a smooth and fast experience in the frontend.
1. **Equation support:** The website has KaTeX support, making it possible for the users to input complex math equations if they want to.
1. **SEO friendly:** Some extra measures have been taken so that the website is mostly rendered on the server, making it possible to crawled by search engines.
1. **Link previews:** If a user shares a link in the social media or texting apps, a nice preview should pop up.
1. **Solutions locked for guest users:** Guest users i.e. users that are not logged can browse the website. They can see the questions too, but they cannot see the solution!
1. **State of the art development technologies:** We used the most professional and modern development tools to build *both the backend and the frontend*. The database is reliable as well as performant. If the need arises, it can be scaled to accommodate any number of students.

There are a lot of planned features too! We're actively working on implementing them. Like:
* A solver will be able to see if another solver is on an unsolved question page. This will imply that another solver may have already engaged in writing a solution for this problem.
* Students will be able to bookmark/save the questions that they like.
* A practice mode. It'll be a better way to browse questions for the students who want to practice. Let's say I picked a specific chapter in practice mode. A random question from that chapter will show up. Once I'm done practicing that, I hit next, another will appear. Like a gallery.

And more improvements in the UI are planned!

## Administrative Website

This website is for maintenance and administrative purposes. Here are some of the highlights of what you can do with it:
1. Register and remove solvers
1. Delete questions, comments, solutions
1. Add and remove batches
1. Generate batch and solver wise invoice
1. Take a look at the whole statistics, like how many questions, users, solvers are there etc

There are some planned features too! Like:
* Deactivating student accounts
* Solver payment updates

Et cetera.