{"id":19869933,"url":"https://github.com/khubaibkhan4/flexi-store-server","last_synced_at":"2025-05-02T08:31:30.558Z","repository":{"id":231296564,"uuid":"781401447","full_name":"KhubaibKhan4/Flexi-Store-Server","owner":"KhubaibKhan4","description":"Flexi-Store is a Sever that Contains the Rest API for the Flexi Store Ecommerce Kotlin Multiplatform Project. ","archived":false,"fork":false,"pushed_at":"2024-12-10T15:36:25.000Z","size":36079,"stargazers_count":40,"open_issues_count":0,"forks_count":9,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-04-07T00:13:38.882Z","etag":null,"topics":["api-rest","compose-multiplatform","ecommerce-api","ecommerce-platform","jwt-authentication","kotlin-multiplatform","ktor","ktor-server","products","restapi","restful-api"],"latest_commit_sha":null,"homepage":"https://www.linkedin.com/in/khubaibkhandev/","language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/KhubaibKhan4.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"KhubaibKhan4","patreon":"MuhammadKhubaibImtiaz","open_collective":null,"ko_fi":"muhammadkhubaibimtiaz","tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"lfx_crowdfunding":null,"polar":null,"buy_me_a_coffee":"khubaibkhan","custom":"https://paypal.me/18.bscs"}},"created_at":"2024-04-03T10:06:14.000Z","updated_at":"2025-03-16T11:42:15.000Z","dependencies_parsed_at":"2024-08-12T14:31:00.508Z","dependency_job_id":"9aa65bbb-5874-42ac-8966-47fb12d81422","html_url":"https://github.com/KhubaibKhan4/Flexi-Store-Server","commit_stats":null,"previous_names":["khubaibkhan4/flexi-store-server"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KhubaibKhan4%2FFlexi-Store-Server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KhubaibKhan4%2FFlexi-Store-Server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KhubaibKhan4%2FFlexi-Store-Server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KhubaibKhan4%2FFlexi-Store-Server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/KhubaibKhan4","download_url":"https://codeload.github.com/KhubaibKhan4/Flexi-Store-Server/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252008808,"owners_count":21679645,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api-rest","compose-multiplatform","ecommerce-api","ecommerce-platform","jwt-authentication","kotlin-multiplatform","ktor","ktor-server","products","restapi","restful-api"],"created_at":"2024-11-12T16:07:25.094Z","updated_at":"2025-05-02T08:31:30.545Z","avatar_url":"https://github.com/KhubaibKhan4.png","language":"Kotlin","funding_links":["https://github.com/sponsors/KhubaibKhan4","https://patreon.com/MuhammadKhubaibImtiaz","https://ko-fi.com/muhammadkhubaibimtiaz","https://buymeacoffee.com/khubaibkhan","https://paypal.me/18.bscs"],"categories":[],"sub_categories":[],"readme":"# Flexi-Store-Server\n\nFlexi Store is an Ecommerce Application Server designed to provide a flexible and scalable backend for online stores.\n\n## Table of Contents\n\n- [Introduction](#introduction)\n- [Features](#features)\n- [Installation](#installation)\n- [Usage](#usage)\n- [API Endpoints](#api-endpoints)\n- [Screenshots](#screenshots)\n- [Contributing](#contributing)\n- [License](#license) \n\n## Introduction\n\nFlexi Store is a server-side application designed to support ecommerce functionalities. It provides a robust backend system for managing users, categories, and products, facilitating the development of ecommerce platforms.\n\n## Features\n\n- User authentication and authorization\n- CRUD operations for managing users, categories, and products\n- Secure API endpoints for interacting with the server\n- Flexible and scalable architecture for accommodating future enhancements\n- User Data Setup Sotring.\n- Order Setup, Order Completion and Order Status Integration.\n\n## Future Plans \n- Deployment on Heroku or Google.\n- Enhancement to old Codebase.\n- Add Feature Brands Category\n\n## Installation\n\nTo install Flexi Store Server locally, follow these steps:\n\n1. Clone the repository:\n\n   ```bash\n   git clone https://github.com/your-username/flexi-store-server.git\n2. Navigate to the project directory:\n   ```\n   cd flexi-store-server\n3. Install dependencies:\n  ```\n   ./gradlew build\n```\n4. Start the server:\n   ```\n   ./gradlew run\n    ```\n## Setup\nRemember you need to setup the Flexi-Store Server to use the Flexi-Store Applications. It's mandatory, otherwise it will not work at all. To Setup, you need to clone this on your local device. Open it in the Intellij IDEA. \nAfter Cloning the project, You need to download the `PG Admin 4` from there official website and install it. After Installing that, You need to create a data with any name. Now, open the Intellij IDEA where your cloning project is running, Click on `Edit / Run Configuration \u003e Environment Variables \u003e`, here you need to add two values inside the variables. `JDBC_DATABASE_URL= jdbc:postgresql:databaseName?user=postgres\u0026password=yourpass` \u0026 `JDBC_DRIVER= org.postgresql.Driver`. After Adding these into your Environment Variables, You are good to go. To Use this Server inside your Application Locally, You need to simply get the local ip. For that you need to `Terminal` or `Command Prompt`. Get the Local IP and replace the base URL `kotlin/utils/Constant.kt` \u0026 URL `http://your_ip:8080/`. If you still gets any error, Please create an issue here.\n\n## Flexi-Store-KMP\n\nFlexi-Store is developed using Ktor and is mandatory for the backend of the Flexi-Store-KMP. You can find the Flexi-Store-KMP repository [here](https://github.com/KhubaibKhan4/Flexi-Store-KMP). \n\n# API Endpoints\n\n## Users\n\n#### Get all Users\n\n```http\n  GET /v1/users\n```\n\n| Parameter | Type     | Description                |\n| :-------- | :------- | :------------------------- |\n| `api_key` | `string` | **Not Required**. Your API key |\n\n#### Get Single User\n\n```http\n  GET /v1/users/{id}\n```\n\n| Parameter | Type     | Description                       |\n| :-------- | :------- | :-------------------------------- |\n| `id`      | `string` | **Required**. Id of item to fetch |\n\n#### Create a New User\n\n```http\n  POST /v1/users\n```\n\n#### Login\n\n```http\n  GET /v1/login\n```\n\n#### Delete Single User\n\n```http\n  DELETE /v1/users/{id}\n```\n\n| Parameter | Type     | Description                       |\n| :-------- | :------- | :-------------------------------- |\n| `id`      | `string` | **Required**. Id of users to delete data |\n\n#### Update Single User\n\n```http\n  PUT /v1/users/{id}\n```\n\n| Parameter | Type     | Description                       |\n| :-------- | :------- | :-------------------------------- |\n| `id`      | `string` | **Required**. Id of users to update data |\n\n\n## Categories\n\n#### Create New Category\n\n```http\n  POST /v1/categories\n```\n\n| Parameter | Type     | Description                       |\n| :-------- | :------- | :-------------------------------- |\n| `api-key`      | `string` | **Not Required**. api-key for authentication |\n\n#### Get All Categories\n\n```http\n  GET /v1/categories\n```\n\n| Parameter | Type     | Description                       |\n| :-------- | :------- | :-------------------------------- |\n| `api-key`      | `string` | **Not Required**. api-key for authentication |\n\n#### Get Category By ID\n\n```http\n  GET /v1/categories/{id}\n```\n\n| Parameter | Type     | Description                       |\n| :-------- | :------- | :-------------------------------- |\n| `id`      | `string` | **Required**. Id of Category |\n\n#### DELETE Category By ID\n\n```http\n  DELETE /v1/categories/{id}\n```\n\n| Parameter | Type     | Description                       |\n| :-------- | :------- | :-------------------------------- |\n| `id`      | `string` | **Required**. Id of Category |\n\n### Update Category\n```http\n  PUT /v1/categories/{id}\n```\n\n| Parameter | Type     | Description                       |\n| :-------- | :------- | :-------------------------------- |\n| `id`      | `string` | **Required**. Id of Category |\n\n## Products\n\n### Create New Product\n```http\n  POST /v1/products\n```\n\n| Parameter | Type     | Description                       |\n| :-------- | :------- | :-------------------------------- |\n| `api-key`      | `string` | **Required**. api-key for Authentication |\n\n### Get Product\n```http\n  GET /v1/products/{id}\n```\n\n| Parameter | Type     | Description                       |\n| :-------- | :------- | :-------------------------------- |\n| `id`      | `string` | **Required**. id for products |\n\n### DELETE Product\n```http\n  DELETE /v1/products/{id}\n```\n\n| Parameter | Type     | Description                       |\n| :-------- | :------- | :-------------------------------- |\n| `id`      | `string` | **Required**. id for products |\n\n### Update Product\n```http\n  PUT /v1/products/{id}\n```\n\n| Parameter | Type     | Description                       |\n| :-------- | :------- | :-------------------------------- |\n| `id`      | `string` | **Required**. id for products |\n\n\n## Promotions Cards\n\n### Create New Promotions\n```http\n  POST /v1/promotions\n```\n\n| Parameter | Type     | Description                       |\n| :-------- | :------- | :-------------------------------- |\n| `api-key`      | `string` | **Required**. api-key for Authentication |\n\n### Get All Promotions\n```http\n  GET /v1/promotions\n```\n\n| Parameter | Type     | Description                       |\n| :-------- | :------- | :-------------------------------- |\n| `api-key`      | `string` | **Required**. api-key for Authentication |\n\n### Get Single Promotion\n```http\n  GET /v1/promotions/{id}\n```\n\n| Parameter | Type     | Description                       |\n| :-------- | :------- | :-------------------------------- |\n| `id`      | `string` | **Required**. id for promotion |\n\n\n### Delete Promotion\n```http\n  DELETE /v1/promotions/{id}\n```\n\n| Parameter | Type     | Description                       |\n| :-------- | :------- | :-------------------------------- |\n| `id`      | `string` | **Required**. id for promotion |\n\n### Update Promotion\n```http\n  PUT /v1/promotions/{id}\n```\n\n| Parameter | Type     | Description                       |\n| :-------- | :------- | :-------------------------------- |\n| `id`      | `string` | **Required**. id for promotion |\n\n\n  ## 💰 You can help me by Donating\n  [![BuyMeACoffee](https://img.shields.io/badge/Buy%20Me%20a%20Coffee-ffdd00?style=for-the-badge\u0026logo=buy-me-a-coffee\u0026logoColor=black)](https://buymeacoffee.com/khubaibkhan) [![PayPal](https://img.shields.io/badge/PayPal-00457C?style=for-the-badge\u0026logo=paypal\u0026logoColor=white)](https://paypal.me/18.bscs) [![Patreon](https://img.shields.io/badge/Patreon-F96854?style=for-the-badge\u0026logo=patreon\u0026logoColor=white)](https://patreon.com/MuhammadKhubaibImtiaz) [![Ko-Fi](https://img.shields.io/badge/Ko--fi-F16061?style=for-the-badge\u0026logo=ko-fi\u0026logoColor=white)](https://ko-fi.com/muhammadkhubaibimtiaz) \n\n# Screenshots\n\n![Screenshot 1](https://github.com/KhubaibKhan4/Flexi-Store-Server/blob/master/assests/screenshots/1.png)\n![Screenshot 2](https://github.com/KhubaibKhan4/Flexi-Store-Server/blob/master/assests/screenshots/2.png)\n![Screenshot 3](https://github.com/KhubaibKhan4/Flexi-Store-Server/blob/master/assests/screenshots/3.png)\n![Screenshot 4](https://github.com/KhubaibKhan4/Flexi-Store-Server/blob/master/assests/screenshots/4.png)\n![Screenshot 5](https://github.com/KhubaibKhan4/Flexi-Store-Server/blob/master/assests/screenshots/5.png)\n![Screenshot 6](https://github.com/KhubaibKhan4/Flexi-Store-Server/blob/master/assests/screenshots/6.png)\n![Screenshot 7](https://github.com/KhubaibKhan4/Flexi-Store-Server/blob/master/assests/screenshots/7.png)\n![Screenshot 8](https://github.com/KhubaibKhan4/Flexi-Store-Server/blob/master/assests/screenshots/8.png)\n![Screenshot 9](https://github.com/KhubaibKhan4/Flexi-Store-Server/blob/master/assests/screenshots/9.png)\n![Screenshot 10](https://github.com/KhubaibKhan4/Flexi-Store-Server/blob/master/assests/screenshots/10.png)\n![Screenshot 11](https://github.com/KhubaibKhan4/Flexi-Store-Server/blob/master/assests/screenshots/11.png)\n\n**Stargazers**\n\n[![Stargazers repo roster for @KhubaibKhan4/Flexi-Store-Server](http://reporoster.com/stars/dark/KhubaibKhan4/Flexi-Store-Server)](https://github.com/KhubaibKhan4/Flexi-Store-Server/stargazers)\n\n**Forkers**\n\n[![Forkers repo roster for @KhubaibKhan4/Flexi-Store-Server](http://reporoster.com/forks/dark/KhubaibKhan4/Flexi-Store-Server)](https://github.com/KhubaibKhan4/Flexi-Store-Server/network/members)\n\n# Contributing\n\nContributions are welcome! Please check the CONTRIBUTING.md file for guidelines.\n\n# License\n\nThis project is licensed under the MIT License - see the LICENSE file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkhubaibkhan4%2Fflexi-store-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkhubaibkhan4%2Fflexi-store-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkhubaibkhan4%2Fflexi-store-server/lists"}