Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/khubaibkhan4/flexi-store-server
Flexi-Store is a Sever that Contains the Rest API for the Flexi Store Ecommerce Kotlin Multiplatform Project.
https://github.com/khubaibkhan4/flexi-store-server
api-rest compose-multiplatform ecommerce-api ecommerce-platform jwt-authentication kotlin-multiplatform ktor ktor-server products restapi restful-api
Last synced: 3 months ago
JSON representation
Flexi-Store is a Sever that Contains the Rest API for the Flexi Store Ecommerce Kotlin Multiplatform Project.
- Host: GitHub
- URL: https://github.com/khubaibkhan4/flexi-store-server
- Owner: KhubaibKhan4
- License: gpl-3.0
- Created: 2024-04-03T10:06:14.000Z (10 months ago)
- Default Branch: master
- Last Pushed: 2024-10-12T10:10:44.000Z (4 months ago)
- Last Synced: 2024-11-07T11:43:38.475Z (3 months ago)
- Topics: api-rest, compose-multiplatform, ecommerce-api, ecommerce-platform, jwt-authentication, kotlin-multiplatform, ktor, ktor-server, products, restapi, restful-api
- Language: Kotlin
- Homepage: https://www.linkedin.com/in/khubaibkhandev/
- Size: 34.4 MB
- Stars: 32
- Watchers: 3
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Flexi-Store-Server
Flexi Store is an Ecommerce Application Server designed to provide a flexible and scalable backend for online stores.
## Table of Contents
- [Introduction](#introduction)
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [API Endpoints](#api-endpoints)
- [Screenshots](#screenshots)
- [Contributing](#contributing)
- [License](#license)
## Introduction
Flexi 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.
## Features
- User authentication and authorization
- CRUD operations for managing users, categories, and products
- Secure API endpoints for interacting with the server
- Flexible and scalable architecture for accommodating future enhancements
## Future Plans
- Deployment on Heroku or Google.
- Enhancement to old Codebase.
## Installation
To install Flexi Store Server locally, follow these steps:
1. Clone the repository:
```bash
git clone https://github.com/your-username/flexi-store-server.git
2. Navigate to the project directory:
```
cd flexi-store-server
3. Install dependencies:
```
./gradlew build
```
4. Start the server:
```
./gradlew run
```
## Setup
Remember 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.
After 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 > Environment Variables >`, here you need to add two values inside the variables. `JDBC_DATABASE_URL= jdbc:postgresql:databaseName?user=postgres&password=yourpass` & `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` & URL `http://your_ip:8080/`. If you still gets any error, Please create an issue here.
## Flexi-Store-KMP
Flexi-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).
# API Endpoints
## Users
- **POST /v1/users**: Create a new user.
- **POST /v1/login**: Authenticate user login.
- **GET /v1/users**: Get all users.
- **GET /v1/users/{id}**: Get user by ID.
- **DELETE /v1/users/{id}**: Delete user by ID.
- **PUT /v1/users/{id}**: Update user by ID.
## Categories
- **POST /v1/categories**: Create a new category.
- **GET /v1/categories**: Get all categories.
- **GET /v1/categories/{id}**: Get category by ID.
- **DELETE /v1/categories/{id}**: Delete category by ID.
- **PUT /v1/categories/{id}**: Update category by ID.
## Products
- **POST /v1/products**: Create a new product.
- **GET /v1/products**: Get all products.
- **GET /v1/products/{id}**: Get product by ID.
- **DELETE /v1/products/{id}**: Delete product by ID.
- **PUT /v1/products/{id}**: Update product by ID.
## Promotions Cards
- **POST /v1/promotions**: Create a new promotions product.
- **GET /v1/promotions**: Get all promotions products.
- **GET /v1/promotions/{id}**: Get promotions product by ID.
- **DELETE /v1/promotions/{id}**: Delete promotions product by ID.
- **PUT /v1/promotions/{id}**: Update promotions product by ID.
## 💰 You can help me by Donating
[](https://buymeacoffee.com/khubaibkhan) [](https://paypal.me/18.bscs) [](https://patreon.com/MuhammadKhubaibImtiaz) [](https://ko-fi.com/muhammadkhubaibimtiaz)
# Screenshots
# Contributing
Contributions are welcome! Please check the CONTRIBUTING.md file for guidelines.
# License
This project is licensed under the MIT License - see the LICENSE file for details.