Skip to content

Commit

Permalink
Docs updates
Browse files Browse the repository at this point in the history
  • Loading branch information
ScottWest742 committed Aug 25, 2023
1 parent 9fb09a8 commit 5dd013f
Showing 1 changed file with 30 additions and 24 deletions.
54 changes: 30 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,18 @@
# Fireshop - Hugo with Svelte Web Components App
# Fireshop 🔥 - Hugo with Svelte Web Components App 💥💥

[![Fiverr](https://img.shields.io/badge/fiverr-1DBF73?style=for-the-badge&logo=fiverr&logoColor=white)](./LICENSE)
[![Upwork](https://img.shields.io/badge/UpWork-6FDA44?style=for-the-badge&logo=Upwork&logoColor=white)](./LICENSE)
[![Dicord: Invite](https://img.shields.io/badge/Discord-5865F2?style=for-the-badge&logo=discord&logoColor=white)](./LICENSE)
[![Whatsapp](https://img.shields.io/badge/WhatsApp-25D366?style=for-the-badge&logo=whatsapp&logoColor=white)](./LICENSE)
[![Youtube](https://img.shields.io/badge/YouTube-FF0000?style=for-the-badge&logo=youtube&logoColor=white)](./LICENSE)
[![Twitter](https://img.shields.io/badge/Twitter-1DA1F2?style=for-the-badge&logo=twitter&logoColor=white)](./LICENSE)

<img src="./static/img/fireshop.png" alt="logo" width="240"/>
<!-- ![Intro](./static/img/fireshop.png) { width:"300px"; height:"200px"} -->

Fireshop is a powerful and dynamic e-commerce website template that combines the flexibility of Hugo and the interactivity of Svelte Web Components. This template allows you to build stunning online shops with blazing-fast performance and seamless user experiences. Whether you're a developer looking for an efficient way to create an e-commerce site or a business owner who wants to launch an online store, Fireshop has got you covered.

## Table of Contents
## Table of Contents 🌟

- [Live Site](#live-site)
- [Features](#features)
Expand All @@ -24,7 +31,7 @@ Fireshop is a powerful and dynamic e-commerce website template that combines the
- [Discord sever](#discord-server)
- [License](#license)

## Live Site
## Live Site 🚗

You can view the [demo site](https://fire-shop.netlify.app)

Expand All @@ -46,25 +53,25 @@ You can view the [demo site](https://fire-shop.netlify.app)

- **Data Fetching**: Fetch data from external APIs to display real-time product information and updates.

## Project TODO's
## Project TODO's 🚀

- [x] Revolt Merchant API's for customer notification
- [x] Supabase user authentication
- [x] Supabase Serveless edge functions
- [ ] Mpesa Payments
- [ ] Glovo or Sendy kenya delivery service

## Getting Started
## Getting Started 🚗

### Prerequisites
### Prerequisites 📜

Before you begin, ensure you have the following installed:

- **Hugo**: You can download and install Hugo from [Hugo's official website](https://gohugo.io/getting-started/installing/).

- **Node.js and npm**: Svelte requires Node.js and npm. You can download them from [Node.js official website](https://nodejs.org/).

### Installation
### Installation 🧠

1. Clone the Fireshop repository:

Expand All @@ -80,24 +87,23 @@ Before you begin, ensure you have the following installed:

3. You own git dev branch (optional)

```bash
git checkout -b your_dev_branch_name
```
```bash
git checkout -b your_dev_branch_name
```

4. Install the required Node.js dependencies:

```bash
npm install
```

### Configuration
### Configuration 🛠️

1. **Hugo Configuration**: Update the `config.toml` file in the root directory to configure your Hugo site settings, such as site title, description, and more.

2. **Svelte Configuration**: Modify Svelte components in the `src/components` directory to customize the user interface and functionality.

## Usage

## Usage 💡

- `npm start`: Main dev server. Runs everything you need.
- `npm run svelte`: Runs components in isolation. Serves `app/index.html` as a playground for components.
Expand All @@ -106,9 +112,9 @@ Before you begin, ensure you have the following installed:

This command will build and serve the Hugo site along with the Svelte components. Open your browser and navigate to `http://localhost:6969` to see your Fireshop in action!

## Customization
## Customization 🌟

### Developing Components
### Developing Components 🤓

Create a Svelte file in the `app/components` directory. It must have a custom element tag.

Expand Down Expand Up @@ -137,30 +143,30 @@ Now use it in anywhere in your HTML or Markdown.
**Note 1:** Web components styles are encapsulated through the [Shadow DOM](https://web.dev/shadowdom-v1/). Global styles will not work as part of Shadow DOM concept of styling.
**Note 2:** You can use Tailwind, with `@apply` in the component or the css used by [tailwindcss docs](https://v2.tailwindcss.com/docs).

### Theming
### Theming 🌈

- You can customize the theme of your Fireshop by editing Hugo templates located in the `layouts` directory.
- You can customize the theme of your Fireshop by editing Hugo templates located in the `layouts` directory.
- Styles can be found in the `styles` directory
- Components for the Svelte portion of the app can be found in the `src/components` directory.

### Product Catalog
### Product Catalog 📊

Manage your product catalog by creating and editing content files in the `content/products` directory. You can utilize Hugo's content management system to easily add, remove, or update products.
### API Integration
### API Integration 📈
To fetch real-time product information, integrate with external APIs by modifying Svelte components in the `src/components` directory. Use libraries like `fetch` or `axios` to make API requests.
## Contributing
## Contributing 🤝
We welcome contributions from the community! If you'd like to contribute to Fireshop, please review our [contribution guidelines](CONTRIBUTING.md).

## Discord server 🎉

## Discord server

## License
## License 📜

Fireshop is released under the [MIT License](LICENSE).
Fireshop is released under the [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](./LICENSE)
.

---

Expand Down

0 comments on commit 5dd013f

Please sign in to comment.