Create the Initial README.md file

[SahooBishwajeet]

TODO

• [x] Include the current project idea
• [x] ~Add links to the project submission pdf~
• [x] Add diagrams/flowcharts

---

• [ ] IMP Add the ROADMAP of the project

---

• [ ] Mention the scope of the project
• [ ] Also mention the limitations of the project

---

• [ ] (FUTURE) Add features along with their screenshots as we build them

[SahooBishwajeet]

• Key Features
  • File Supported
  • File Storage
  • File Explorer
  • File Format Conversion
  • File Sharing
  • End-To-End Encryption
  • In-Browser File Editor
• User Management
  • Multiple roles
  • Account & Security
• Software Practices (Written in detail below)
• Tech Stack (Written in detail below)
• API Design (If we can do it)
• Database Design (Explain the overview of the backend and the paradigms we are using)
• Reliability & Security

[SahooBishwajeet]

Tech Stack

• HTML5
• CSS3 (Tailwind CSS)
• Javascript
• ejs
• Expressjs
• Nodejs
• MongoDB

More to be added later as I remember them or we use them :)

[SahooBishwajeet]

Software Practices

• YAGNI
• Test infrastructure, not external code
• Extract repeated code after third use (DRY)
• Simple things first, complex things possible - API Design (KISS)
• Fail fast
• Unit testing principles
• Aim for 100% code coverage
• Code is the enemy
• Be cautious with comments
• Write defensively