/ojami

Primary LanguageTypeScript

image

Contributors Forks Stargazers Issues


Logo

ọjà mi

A new shopping experience powered by Kora
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

Many small businesses across Africa lack an efficient digital presence to showcase their products and services. They often rely on traditional methods such as physical storefronts or basic social media accounts, which limits their market reach and scalability. Without access to integrated e-commerce tools, these businesses miss out on opportunities to engage a broader audience, track inventory efficiently, and accept seamless digital payments.

Additionally, physical businesses, such as resorts, arcades, restaurants, and local retail stores, often face challenges in offering flexible, contactless payment options. While many businesses use methods like POS systems or bank transfers, they struggle with tracking, managing, and labeling these payments effectively. This leads to inefficiencies, missed opportunities for improving customer satisfaction, and difficulty building loyalty among modern, tech-savvy consumers.

We have created a solution to address these challenges. Our platform, ọjà mi, empowers small businesses to establish a strong online presence, manage their inventory efficiently, and accept seamless digital payments. By leveraging our platform, businesses can:

  • Showcase their products and services to a broader audience
  • Track inventory and manage sales efficiently
  • Accept seamless digital payments from customers
  • Offer flexible, contactless payment options to customers
  • Track, manage, and label payments effectively
  • An innovative offline payment system
  • Improve customer experience using shopping assistants and augmented reality

(back to top)

Built With

We were able to build this project using the following technologies:

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

Installation

You can install the dependencies using npm, yarn, pnpm, or bun. You will need to have API Keys from OpenAI and Korapay to run the project.

  1. Get a test API Keys at https://developers.korapay.com
  2. Clone the repo
    git clone https://github.com/owolabioromidayo/ojami.git
  3. Install dependencies
  • npm

    npm install
  • yarn

    yarn install
  • pnpm

    pnpm install
  • bun

    bun install
  1. Setup your postgres database and update the .env file with your credentials
  2. Setup redis-server and update the .env file with your credentials
  3. See the open issues for a full list of proposed features (and known issues).

The project is separated into two main parts, the frontend and the backend.

Starting up the frontend

/client

  1. Run the development server
    npm run dev

Starting up the backend

/node-server

  1. Run the development server
    npm start

Project Structure

ojami/
├── node-server/        # Node.js backend for API and integration with Kora and AI Models
│   └── src/
│       └── index.ts
│       └── mikro-orm.config.ts
│       └── entities/      # Database entities
│       └── migrations/     # Database migrations
│       └── routes/     # API routes
│       └── types.ts     # Type definitions
│       └── utils/     # Utility functions
│       └── middleware/     # Middleware
│   └── .env     # Environment variables
│
├── client/       # Next.js frontend for the application
│   └── lib/
│       └── src/
│           └── pages/    # App pages
│           └── components/    # Reusable UI components
│           └── lib/    
│           └── utils/     
│           └── styles/     # Global styles
│
│
└── README.md

(back to top)

Screenshots

image

image

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Top contributors:

contrib.rocks image

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)