Skip to content

Storepoint-NG/storepoint-dashboard

Repository files navigation

Storepoint: E-Commerce for SMEs

Welcome to the Storepoint GitHub repository! Storepoint is an e-commerce platform designed specifically for small businesses and local shop owners. Our integration with the Squad API by GTBank ensures secure and efficient payment processing, making online transactions smooth and trustworthy.

Features

  • User-Friendly Interface: Easy-to-navigate design for both shop owners and customers.
  • Next.js Framework: Optimized for performance, SEO, and scalability.
  • Squad API Integration: Secure payment processing through GTBank's Squad API.
  • Responsive Design: Works seamlessly on desktop, tablet, and mobile.
  • Customizable Storefronts: Tailor your e-commerce site to match your brand.
  • Inventory Management: Simple and intuitive product and inventory management.
  • Analytics Dashboard: Understand your sales and customer behavior.
  • Open Source: Community-driven development for continuous improvement.

Getting Started

Prerequisites

Before you set up Storepoint, ensure you have the following:

  • Node.js (version 14 or above)
  • Git
  • A GTBank Squad API account for payment processing

Installation

Clone the Repository

git clone https://github.com/your-username/Storepoint.git
cd Storepoint

Install Dependencies

To install the necessary dependencies, run the following command in your terminal:

npm install

Set Up Environment Variables

You need to set up your environment variables for the application to function correctly:

  1. Rename the .env.example file to .env.local.
  2. Open the .env.local file and update the values with your GTBank Squad API keys and other configurations as required.

Run the Development Server

After setting up your environment variables, you can start the development server:

npm run dev

Once the server is running, you can visit http://localhost:3000 in your web browser to view the application.

Contributing

We welcome contributions from the community! If you're interested in helping improve Storepoint, please check out our Contributing Guidelines for more information on how to get started.

Support

If you encounter any issues or have questions, feel free to open an issue in the GitHub repository or check our FAQs.

License

Storepoint is released under the MIT License.

Acknowledgements

  • Adekomi Abdulhaleem, Haruna Faruk
  • GTBank for the Squad API
  • Next.js Community