An open API service indexing awesome lists of open source software.

https://github.com/rk-vashista/sahara

Sahara is a modern eCommerce platform built with Svelte and Tailwind CSS. It features Firebase authentication and a PostgreSQL backend, offering a seamless shopping experience with a responsive design, secure payment integration, and an admin dashboard for product management.
https://github.com/rk-vashista/sahara

firebase postgresql-database svelte tailwindcss

Last synced: 6 months ago
JSON representation

Sahara is a modern eCommerce platform built with Svelte and Tailwind CSS. It features Firebase authentication and a PostgreSQL backend, offering a seamless shopping experience with a responsive design, secure payment integration, and an admin dashboard for product management.

Awesome Lists containing this project

README

          

# ๐Ÿœ๏ธ **Sahara** โ€” Online eCommerce Website

Sahara is a modern, full-featured online eCommerce platform, designed to deliver a smooth and visually appealing shopping experience. Built with **Svelte** and **Tailwind CSS**, it uses **Firebase** for authentication and **PostgreSQL** for robust backend functionality.

---

## ๐Ÿš€ **Features**
Sahara offers a rich set of features to enhance the user experience and ease of management.

- ๐Ÿ›’ **Product Browsing**: Seamless browsing through categories and featured items.
- ๐Ÿ” **Authentication**: Secure user login and signup via Firebase.
- ๐Ÿงพ **Shopping Cart**: Easily add products to the cart with real-time updates.
- ๐Ÿ’ณ **Payment Integration**: Built-in support for secure payments.
- ๐Ÿ“Š **Admin Dashboard**: Manage products, categories, and users.
- ๐Ÿ”„ **Responsive Design**: Fully responsive across devices.

---

## ๐Ÿ› ๏ธ **Tech Stack**
Sahara is built using cutting-edge technologies to ensure performance, scalability, and flexibility.

- **Frontend**: Svelte, TailwindCSS
- **Backend**: PostgreSQL, Node.js (for APIs)
- **Authentication**: Firebase Authentication
- **Deployment**: Docker, Vercel (Optional)

---

## ๐Ÿ“– **Getting Started**

Follow these instructions to get the Sahara eCommerce platform running on your local machine.

### **1. Prerequisites**

- Node.js
- PostgreSQL
- Firebase account (for authentication)

### **2. Installation**

First, clone the repository:

```bash
git clone https://github.com/rk-vashista/Sahara.git
```

Navigate to the project folder:

```bash
cd sahara
```

Install the necessary dependencies:

```bash
npm install
```

### **3. Configuration**

Set up environment variables by creating a `.env` file in the root directory:

```bash
# .env
POSTGRES_URL= your_postgres_url
VITE_FIREBASE_API_KEY= your_firebase_api_key
VITE_FIREBASE_AUTH_DOMAIN= your_firebase_auth_domain
VITE_FIREBASE_PROJECT_ID= your_firebase_project_id
VITE_FIREBASE_STORAGE_BUCKET= your_firebase_storage_bucket
VITE_FIREBASE_MESSAGING_SENDER_ID= your_firebase_messaging_sender_id
VITE_FIREBASE_APP_ID= your_firebase_app_id
```

### **4. Database Setup**

Make sure PostgreSQL is running and create the database:

```bash
createdb sahara
```

Run migrations (if applicable) to set up tables:

```bash
npm run migrate
```

### **5. Running the Application**

Start the development server:

```bash
npm run dev
```

For production build:

```bash
npm run build
npm run start
```

## ๐Ÿง‘โ€๐Ÿ’ป **Contributing**

Contributions to Sahara are welcome! If you'd like to contribute:

1. Fork the repository.
2. Create your feature branch (`git checkout -b feature/your-feature`).
3. Commit your changes (`git commit -m 'Add feature'`).
4. Push to the branch (`git push origin feature/your-feature`).
5. Open a Pull Request.

---

## ๐Ÿ›ก๏ธ **License**

This project is licensed under the [MIT License](LICENSE).

---