Giter Club home page Giter Club logo

ecommerceapi's Introduction

Kotlin eCommerce API

This project is an eCommerce API built in Kotlin using the Ktor framework. It provides various endpoints and features to support an eCommerce platform.

Features

  • User authentication and authorization using JWT (JSON Web Tokens)
  • CORS (Cross-Origin Resource Sharing) enabled to allow cross-origin requests
  • Serialization and deserialization of JSON using Gson
  • Routing and request handling for different API endpoints
  • Integration with various controllers for handling business logic

Getting Started

To get started with the project, follow these steps:

  1. Clone the repository: git clone <repository-url>
  2. Install Kotlin and its dependencies (if not already installed)
  3. Build the project: gradle clean build
  4. Run the project: gradle run

Make sure to configure any necessary environment variables, database connections, or other settings as per your requirements.

Database Configuration

  • Create a MySQL database with the following credentials:

    • Host: localhost
    • Port: 3306
    • Database Name: fcs
    • Username: root
    • Password: 12345678
  • Run the initial.sql script provided in the project to set up the initial database schema and data.

API Endpoints

The API provides various endpoints for different functionalities. You can access the API documentation and test the endpoints using Postman by clicking the button below:

Run in Postman

Please refer to the source code for detailed request/response structures and additional endpoints.

Dependencies

The project uses the following dependencies:

  • Ktor: Core framework for building web applications in Kotlin
  • JWT: Library for handling JSON Web Tokens for user authentication
  • Gson: Library for serializing and deserializing JSON objects

Make sure to check the build.gradle file for the complete list of dependencies and their versions.

ecommerceapi's People

Contributors

sauravrao637 avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.