{"id":25719103,"url":"https://github.com/suiramdev/storedge-core","last_synced_at":"2026-05-17T05:36:12.757Z","repository":{"id":115912408,"uuid":"602331535","full_name":"suiramdev/storedge-core","owner":"suiramdev","description":"🚀 The API for Storedge, a headless CMS project for e-commerce","archived":false,"fork":false,"pushed_at":"2023-12-29T11:08:03.000Z","size":344,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2023-12-29T12:23:27.876Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://storedge.suiram.dev/graphql","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/suiramdev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2023-02-16T01:26:06.000Z","updated_at":"2023-12-29T12:23:28.707Z","dependencies_parsed_at":"2023-07-04T23:01:16.640Z","dependency_job_id":"4de111fe-895b-491f-bcae-826876f82e74","html_url":"https://github.com/suiramdev/storedge-core","commit_stats":null,"previous_names":[],"tags_count":0,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/suiramdev%2Fstoredge-core","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/suiramdev%2Fstoredge-core/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/suiramdev%2Fstoredge-core/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/suiramdev%2Fstoredge-core/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/suiramdev","download_url":"https://codeload.github.com/suiramdev/storedge-core/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240704974,"owners_count":19844389,"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":[],"created_at":"2025-02-25T16:33:19.354Z","updated_at":"2026-05-17T05:36:07.696Z","avatar_url":"https://github.com/suiramdev.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# storedge-core\n\nThe backbone of Storedge, an innovative headless Content Management System (CMS) designed specifically for e-commerce platforms. This repository is dedicated to the API that powers Storedge, constructed on the strong foundations of GraphQL with TypeGraphQL and Prisma. Our mission is to provide a modular, up-to-date, self-hosted, and open-source alternative inspired by the renowned Shopify.\n\n## Features\n\n-   **GraphQL API**: Empower your e-commerce platform with efficient data queries and mutations using GraphQL.\n-   **TypeGraphQL \u0026 Prisma**: Streamline your development with strong typing and advanced ORM capabilities.\n-   **Modularity**: Our API's modular design allows for easy customization and extension.\n-   **Self-hosted \u0026 Open-source**: Keep full control of your data with self-hosting and enjoy the flexibility of open-source for customization.\n\n## Table of Contents\n\n-   [Getting Started](#getting-started)\n    -   [Prerequisites](#prerequisites)\n    -   [Installation](#installation)\n    -   [Configuration](#configuration)\n    -   [Building the Application](#building-the-application)\n    -   [Initializing the Database](#initializing-the-database)\n    -   [Running the Server](#running-the-server)\n-   [Architecture Overview](#architecture-overview)\n    -   [File Handling](#file-handling)\n-   [Contributing](#contributing)\n-   [License](#license)\n\n## Getting Started\n\nClone the `storedge-core` repository to begin:\n\n```bash\ngit clone https://github.com/suiramdev/storedge-core.git\ncd storedge-core\n```\n\n### Prerequisites\n\nEnsure you have the following installed:\n\n-   Node.js (version v16.20.X or above)\n-   A supported SQL database (e.g., PostgreSQL)\n\n### Installation\n\nInstall the dependencies with `pnpm`:\n\n```bash\npnpm install\n```\n\n### Configuration\n\nSet up your environment variables:\n\n```bash\ncp .env.example .env\n# Make sure to edit the .env file with your database details and other configurations\n```\n\n### Building the Application\n\nCompile the TypeScript source to JavaScript:\n\n```bash\npnpm build\n```\n\n### Initializing the Database\n\nBefore starting the server, initialize your database schema:\n\n```bash\npnpx prisma db push\n```\n\nSeed your database with initial data:\n\n```bash\npnpx prisma db seed\n```\n\n### Running the Server\n\nFinally, launch the storedge-core server:\n\n```bash\npnpm start\n```\n\nYour GraphQL API is now running and can be accessed at `http://localhost:4000/graphql`.\n\n## Architecture Overview\n\nStoredge's architecture is divided into core and apps layers:\n\n-   **Core**: Houses the database, services, and gateway, orchestrating the business logic and data persistence.\n-   **Apps**: This layer contains the storefront and dashboard interfaces. (e.g, \u003chttps://github.com/suiramdev/storedge-dashboard\u003e)\n\n![Architecture overview schema](https://i.imgur.com/DtJWNji.png)\n\n### File Handling\n\n-   **File Downloading**: To securely download files, clients request a presigned URL from the gateway, granting access to the object storage.\n-   **File Uploading**: For uploads, clients use a presigned URL to send files directly to object storage, enhancing security and performance.\n\n![File handling schema](https://i.imgur.com/Z8cdLgo.png)\n\n## Contributing\n\nContributions are welcome! Please refer to the CONTRIBUTING.md file for guidelines on submitting pull requests.\n\n## License\n\nStoredge-Core is licensed under the MIT License. See the LICENSE.md file for more details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsuiramdev%2Fstoredge-core","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsuiramdev%2Fstoredge-core","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsuiramdev%2Fstoredge-core/lists"}