{"id":18576357,"url":"https://github.com/stbestichhh/lcs-cloud-storage-server","last_synced_at":"2025-06-14T05:36:43.611Z","repository":{"id":231298336,"uuid":"781392183","full_name":"stbestichhh/lcs-cloud-storage-server","owner":"stbestichhh","description":"Local cloud storage with authentication on Node.js/ExpressJS","archived":false,"fork":false,"pushed_at":"2024-05-15T13:24:16.000Z","size":361,"stargazers_count":5,"open_issues_count":6,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-05-16T02:51:55.780Z","etag":null,"topics":["cloud-storage","express-js","typescript"],"latest_commit_sha":null,"homepage":"https://lcs-cloud-storage-docs.vercel.app/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stbestichhh.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"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}},"created_at":"2024-04-03T09:44:46.000Z","updated_at":"2024-06-02T14:40:37.174Z","dependencies_parsed_at":"2024-05-16T02:45:31.803Z","dependency_job_id":"93cf1928-d038-477d-812c-0723bea7ec25","html_url":"https://github.com/stbestichhh/lcs-cloud-storage-server","commit_stats":null,"previous_names":["stbestichhh/cloud-storage","stbestichhh/lcs-cloud-storage","stbestichhh/lcs-cloud-storage-api","stbestichhh/lcs-cloud-storage-server"],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stbestichhh%2Flcs-cloud-storage-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stbestichhh%2Flcs-cloud-storage-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stbestichhh%2Flcs-cloud-storage-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stbestichhh%2Flcs-cloud-storage-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stbestichhh","download_url":"https://codeload.github.com/stbestichhh/lcs-cloud-storage-server/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248185365,"owners_count":21061502,"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":["cloud-storage","express-js","typescript"],"created_at":"2024-11-06T23:24:36.524Z","updated_at":"2025-04-10T08:31:12.590Z","avatar_url":"https://github.com/stbestichhh.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Node.js CI](https://github.com/stbestichhh/lcs-cloud-storage-server/actions/workflows/node.js.yml/badge.svg)](https://github.com/stbestichhh/lcs-cloud-storage-server/actions/workflows/node.js.yml)\n[![NPM Version](https://img.shields.io/npm/v/@lcs-cloud-storage/server)](https://www.npmjs.com/package/@lcs-cloud-storage/server)\n[![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)\n[![Open Source Love](https://badges.frapsoft.com/os/v1/open-source.svg?v=103)](https://github.com/ellerbrock/open-source-badges/)\n\n\n# lcs-cloud-storage server\n\n![LCS](.github/screenshots/IMG_2541.JPG)\n\n#### [Visit Documentation website ↗](https://lcs-cloud-storage-docs.vercel.app/)\n\n## Table of contents\n\n* [Description](#about)\n* [Getting started](#getting-started)\n  * [Prerequisites](#prerequisites)\n  * [Installation](#installation)\n  * [Deployment](#deployment)\n  * [Usage](#usage)\n  * [Running tests](#running-tests)\n* [Contributing](#contributing)\n* [Changelog](#changelog)\n* [Authors](#authors)\n* [License](#license)\n\n## About\n\nLCS - is a local cloud storage server.\nThe Local Cloud Storage Server project aims to develop a robust and secure local cloud storage solution.\nThis system will provide users with the ability to store, retrieve, and manage their data locally while enjoying the benefits of cloud storage such as scalability, accessibility, and reliability.\n\nThe server will expose a **RESTful API** that allows users to interact with the storage.\nThis API will support operations such as uploading files, downloading and all default filesystem operations.\n\nIn addition to the API, the system will provide a **Command Line Interface (CLI)**.\nThis will enable users to use server feature or to configure it.\n\n## Getting started\n\n### Prerequisites\n\n* yarn `npm i -g yarn` or `corepack enable`\n\n\u003e [!IMPORTANT]\n\u003e **Node.js 18.x+** version must be installed in your OS.\n\n### Installation\n\n1. Clone the repository\n\n```shell\n$ git clone https://github.com/stbestichhh/lcs-cloud-storage-server.git\n```\n\n2. Install dependencies\n\n```shell\n$ yarn install\n```\n\n#### Or install as NPM package\n\n```shell\n$ npm i -g @lcs-cloud-storage/server\n```\n\n### Deployment\n\n#### Start the server to production\n\n* From cli\n\n  See [usage instructions](#usage) to find out how to use cli\n\n  ```shell\n  $ lcs [options] server|run [options]\n  ```\n\n* From source code\n\n  ```shell\n  $ yarn build\n  $ yarn start:prod\n  ```\n\n* Without installing\n\n  Run default configuration\n\n  ```shell\n  $ docker build -t lcs-cloud-storage .\n  $ docker run -p \u003cport\u003e:9180 lcs-cloud-storage\n  ```\n\n  Override configuration\n  ```shell\n  $ docker build -t lcs-cloud-storage .\n  $ docker run -e \u003cENV\u003e=\u003cvalue\u003e -p \u003cport\u003e:\u003cport\u003e lcs-cloud-storage node dist/index.js [options] [command]\n  ```\n\n  Overriding every enviroment variable is not necessary. Options and command see in [usage](#usage) section.\n\n#### Start server locally\n\n```shell\n$ yarn start:dev\n```\n\n### Usage\n\nSee the usage instruction in the lcs-cloud-storage [documentation](https://lcs-cloud-storage-docs.vercel.app/advanced)\n\n### Running tests\n\n#### Unit tests\n\n```shell\n$ yarn test\n```\n\nwatch mode\n\n```shell\n$ yarn test:watch\n```\n\n#### End to end tests\n\nThis e2e tests are testing server api\n\n```shell\n$ yarn test:e2e\n```\n\nwatch mode\n\n```shell\n$ yarn test:e2e:watch\n```\n\n## Contributing\n\nPlease read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.\n\n## Changelog\n\nProject changes are writen in changelog, see the [CHANGELOG.md](CHANGELOG.md).\n\nWe use [SemVer](https://semver.org/) for versioning.\nFor the versions available, see the [tags](https://github.com/stbestichhh/lcs-cloud-storage-server/tags) on this repository.\n\nFor the supported and unsupported versions, see the [SECURITY.md](SECURITY.md).\n\n## Authors\n\n- [@stbestichhh](https://www.github.com/stbestichhh)\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE.md](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstbestichhh%2Flcs-cloud-storage-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstbestichhh%2Flcs-cloud-storage-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstbestichhh%2Flcs-cloud-storage-server/lists"}