Skip to content

Commit

Permalink
refactored client codebase and planned express backend integration
Browse files Browse the repository at this point in the history
  • Loading branch information
devnadeemashraf committed Jan 1, 2025
1 parent b92cf55 commit 37f7fcd
Show file tree
Hide file tree
Showing 26 changed files with 260 additions and 285 deletions.
20 changes: 4 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,22 +16,18 @@ Auctions is a free and open-source online marketplace that allows you to list yo
- **Discord Integration COMING SOON!**
Get notified through Discord with integration for real-time messages.

- **Appwrite as Backend**
Backend-as-a-Service (BaaS) powered by Appwrite to handle user authentication, databases, and more.

## Tech Stack

- **Frontend**: React, TypeScript, Vite
- **Backend**: Appwrite (Authentication, Databases, and Storage)
- **Notifications**: Discord Integration (via Webhooks)
- **Backend**: Express, TypeScript, MongoDB
- **Notifications**: In-App & Discord Integration (via Webhooks)

## Installation

### Prerequisites

- [Node.js](https://nodejs.org/) (v16 or higher)
- [Vite](https://vitejs.dev/) (for local development)
- [Appwrite Account](https://appwrite.io/) (for backend services)

### Steps to Set Up Locally

Expand All @@ -56,17 +52,11 @@ Auctions is a free and open-source online marketplace that allows you to list yo
yarn install
```

3. **Configure Appwrite:**

- Set up an [Appwrite account](https://appwrite.io/) and create a new project.
- In the Appwrite console, enable authentication and create the necessary collections for storing auction data.
- Get your **Appwrite Project ID** and **API Endpoint** from the Appwrite console.

4. **Configure environment variables:**
3. **Configure environment variables:**

Create a `.env` file in the root of your project and replace the contents with what's in `.env.example`

5. **Run the development server:**
4. **Run the development server:**

Start the Vite development server:

Expand Down Expand Up @@ -96,7 +86,6 @@ Once the application is up and running, you can:
You can deploy this app on any platform that supports static web hosting, such as:

- [Vercel](https://vercel.com/)
- [Appwrite Hosting](https://appwrite.io/)

## Contributing

Expand All @@ -115,6 +104,5 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file

## Acknowledgments

- [Appwrite](https://appwrite.io/) for providing the backend services.
- [React](https://reactjs.org/) and [Vite](https://vitejs.dev/) for the frontend framework and build tool.
- [Discord](https://discord.com/) for integrating notifications. COMING SOON!
1 change: 0 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,6 @@
"@radix-ui/react-toggle-group": "^1.1.1",
"@radix-ui/react-tooltip": "^1.1.6",
"@reduxjs/toolkit": "^2.5.0",
"appwrite": "^16.1.0",
"class-variance-authority": "^0.7.1",
"clsx": "^2.1.1",
"cmdk": "1.0.0",
Expand Down
1 change: 0 additions & 1 deletion public/vite.svg

This file was deleted.

2 changes: 1 addition & 1 deletion src/App.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { BrowserRouter, Route, Routes } from "react-router-dom";

import AppStatusGuard from "@/components/guards/appStatus";
import AppStatusGuard from "@/components/guards/app-status-guard";

import { DashboardPage, ComingSoonPage } from "@/pages";

Expand Down
10 changes: 0 additions & 10 deletions src/api/appwrite/index.ts

This file was deleted.

11 changes: 0 additions & 11 deletions src/api/appwrite/methods/auth.ts

This file was deleted.

1 change: 0 additions & 1 deletion src/assets/react.svg

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,11 @@ const AppStatusGuard = ({ children }: PropsWithChildren) => {
return <Navigate to="/" replace />;
}

{
/**
* Render the 'Router' Component, from react-router-dom, if STATUS is good to go
*/
}
return children;
};

Expand Down
6 changes: 3 additions & 3 deletions src/components/providers/index.tsx
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import { PropsWithChildren } from "react";

// Global Providers
import ReduxProvider from "./reduxProvider";
import ThemeProvider from "./themeProvider";
// Providers
import ReduxProvider from "./redux-provider";
import ThemeProvider from "./theme-provider";

type TRootProviderProps = PropsWithChildren;

Expand Down
Loading

0 comments on commit 37f7fcd

Please sign in to comment.