docs(web): Add documentation about our web package (#268)

keyshade-xyz · Jul 11, 2024 · 3d848e7 · 3d848e7
1 parent d621dcb
commit 3d848e7
Show file tree

Hide file tree

Showing 3 changed files with 45 additions and 0 deletions.
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
@@ -10,6 +10,7 @@
   - [Organization of code](contributing-to-keyshade/design-of-our-code/organization-of-code.md)
   - [API](contributing-to-keyshade/design-of-our-code/api.md)
   - [Integrations](contributing-to-keyshade/design-of-our-code/integrations.md)
+  - [Web](contributing-to-keyshade/design-of-our-code/web.md)
 - [Prerequisites](contributing-to-keyshade/prerequisites.md)
 - [Environment Variables](contributing-to-keyshade/environment-variables.md)
 - [Setting things up](contributing-to-keyshade/setting-things-up.md)

diff --git a/docs/contributing-to-keyshade/design-of-our-code/README.md b/docs/contributing-to-keyshade/design-of-our-code/README.md
@@ -13,3 +13,4 @@ When it comes to developing for us, we follow very strict norms! From proper ind
 - [Organization Of Code](organization-of-code.md)
 * [API](api.md)
 * [Integrations](integrations.md)
+* [Web](web.md)
diff --git a/docs/contributing-to-keyshade/design-of-our-code/web.md b/docs/contributing-to-keyshade/design-of-our-code/web.md
@@ -0,0 +1,43 @@
+# Web
+
+The web application is responsible for serving the homepage, providing users with access to its content and functionality, the stacks, and things you should know before you get started with it!
+
+## Stack
+
+- **Next.js** as the framework
+- **React** as the frontend library
+- **MDX** for Markdown and JSX integration
+- **Tailwind CSS** for utility-first styling
+- **Framer Motion** for animations
+- **Geist** for UI components
+- **@tsparticles/engine, @tsparticles/react, @tsparticles/slim** for particle animations
+- **Sonner** for notifications
+- **TypeScript** for static typing
+
+## Structure
+
+```
+├── web
+    ├── public
+    ├── src
+    |      ├── app
+    |      ├── components        
+    |      └── utils
+    └── config_files
+```
+
+### web
+The main directory that contains all parts of the web app.
+
+#### public
+Contains static files and assets.
+
+#### src
+Contains the source code of the app.
+
+- **app**: Holds the main pages and settings for the app.
+- **components**: Reusable pieces used in the app.
+- **utils**: Helper tools and functions that support the app.
+
+#### config_files
+Contains configuration files for the app.