Restructure Repo

.gitignore

@@ -1,5 +1,3 @@
-# Both
-
 # Both
 **/node_modules/
 **/package-lock.json
@@ -16,7 +14,7 @@
 **/pnpm-lock.yaml
 
 # Frontend
-frontend/dist-ssr
+dist-ssr
 *.local
 
 # Editor directories and files
@@ -32,3 +30,7 @@ frontend/dist-ssr
 # Local Netlify folder
 .netlify
 new-frontend/.vite/** 
+
+# Sentry Config File
+.env.sentry-build-plugin
+

.vite/deps/_metadata.json

@@ -0,0 +1,8 @@
+{
+  "hash": "0dc79804",
+  "configHash": "b1e6faae",
+  "lockfileHash": "2d286c57",
+  "browserHash": "9f93f16a",
+  "optimized": {},
+  "chunks": {}
+}

.vite/deps/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

README.md

@@ -4,28 +4,18 @@
 
 ## Overview
 
-TODO: Rewrite
+The Welcome Collective Inventory Frontend is an inventory management application for the Welcome Collective. The application allows volunteers and management to easily manage incoming and outgoing donations.
 
 ## Project Structure
 
 ```txt
 web-collective-inventory/
-├── new-frontend/
-│ ├── src/
-│ ├── package.json
-│ └── README.md
-
+│
+├── src/
+├── package.json
+└── README.md
 ```
 
-## Technologies Used
-
-### Frontend
-
-- Vite.js
-- React
-- React Query
-- TypeScript
-
 ## Getting Started
 
 ### Prerequisites
@@ -35,18 +25,50 @@ web-collective-inventory/
 
 ### Setting Up the Frontend
 
-1. Navigate to the frontend directory:
+1. clone the repo
+```bash
+git clone https://github.com/hack4impact-mcgill/wc-inventory.git
+cd new-frontend
+```
+
+2. Install the dependencies for the project:
 
 ```bash
-cd frontend
+npm install
 ```
 
-2. Follow the installation instructions in the FE README.
+3. Run the development server:
+
+```bash
+npm run dev
+```
+The app should now be running on [localhost:3000](http://localhost:3000).
+
+## Project Structure
+
+- **`/assets`**: Static assets used across the application.
+- **`/components`**: Reusable UI components.
+- **`/contexts`**: Contexts for application-wide state management, such as authentication.
+- **`/features`**: Grouped features for distinct sections,
+  such as `admin-dashboard` and `volunteer-dashboard`.
+- **`/hooks`**: Custom hooks to abstract common logic.
+- **`/lib`**: Utility files, including API functions.
+- **`/providers`**: Providers for third-party libraries,
+  including React Query and our Router.
+- **`/types`**: Type definitions for structured data and our supabase exported schema.
+
+
+## Technologies
+
+- **Supabase**: Used for DB and authentication services.
+  For more information, visit [Supabase](https://supabase.com/).
+- **TailwindCSS**: Utility-first CSS framework for styling.
+  For more information, visit [TailwindCSS](https://tailwindcss.com/).
+- **shadcn/ui**: Styled component library providing reusable UI elements,
+  built on top of TailwindCSS.
+  Learn more at [shadcn](https://shadcn.dev/).
 
-## Development Workflow
 
-1. Start the FE development server.
-2. Access the application via Browser (usually `http://localhost:3000`).
 
 ## Contributing
 
@@ -57,3 +79,32 @@ cd frontend
 5. Push your changes and create a pull request.
 6. Code Review
 7. Merge into Dev
+
+
+
+
+## Contributing
+
+1. **Fork the repository** and create a story branch, where # is the number of your ticket:
+
+   ```bash
+   git checkout -b WC-##
+   ```
+
+2. **Stage and commit your changes**:
+
+   ```bash
+   git add .
+   git commit -m "[WC-#] Add your feature"
+   ```
+
+3. **Write or update tests as necessary**.
+
+4. **Push to your branch** and then create a pull request:
+
+   ```bash
+   git push origin WC-#
+   ```
+
+5. **Code Review and Merge**
+