file-storage-server-template

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

file-storage-server-template

★ 8 Open GitHub ↗

File Storage Server Template is a generic open-source file storage server that has a simple yet powerful design to connect your business with third-party file storage provider companies (AWS S3, Google Cloud Storage).

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<h1 align="center">
Open Template Hub - File Storage Server Template v5
</h1>

[![License](https://img.shields.io/github/license/open-template-hub/file-storage-server-template?color=43b043&style=for-the-badge)](https://raw.githubusercontent.com/open-template-hub/file-storage-server-template/develop/LICENSE)
[![Issues](https://img.shields.io/github/issues/open-template-hub/file-storage-server-template?color=43b043&style=for-the-badge)](https://github.com/open-template-hub/file-storage-server-template/issues)
[![PRCLosed](https://img.shields.io/github/issues-pr-closed-raw/open-template-hub/file-storage-server-template?color=43b043&style=for-the-badge)](https://github.com/open-template-hub/file-storage-server-template/pulls?q=is%3Apr+is%3Aclosed)
[![LastCommit](https://img.shields.io/github/last-commit/open-template-hub/file-storage-server-template?color=43b043&style=for-the-badge)](https://github.com/open-template-hub/file-storage-server-template/commits/master)
[![Release](https://img.shields.io/github/release/open-template-hub/file-storage-server-template?include_prereleases&color=43b043&style=for-the-badge)](https://github.com/open-template-hub/file-storage-server-template/releases)
[![SonarCloud](https://img.shields.io/sonar/quality_gate/open-template-hub_file-storage-server-template?server=https%3A%2F%2Fsonarcloud.io&label=Sonar%20Cloud&style=for-the-badge&logo=sonarcloud)](https://sonarcloud.io/dashboard?id=open-template-hub_file-storage-server-template)

## Ways to Begin

npm install --save-dev @types/node

### 1. Express Deploy

Deploy this template to Heroku

[![Deploy](https://img.shields.io/badge/Deploy_to-Heroku-7056bf.svg?style=for-the-badge&logo=heroku)](https://heroku.com/deploy?template=https://github.com/open-template-hub/file-storage-server-template)

### 2. Start with Server Generator

Create your server with Server Generator Package

[![NPM](https://img.shields.io/badge/NPM-server_generator-cb3837.svg?style=for-the-badge&logo=npm)](https://www.npmjs.com/package/@open-template-hub/server-generator)

### 3. GitHub Template

Use this repository as a Template

[![GitHubTemplate](https://img.shields.io/badge/GitHub-Template-24292e.svg?style=for-the-badge&logo=github)](https://github.com/open-template-hub/file-storage-server-template/generate)

## Installations

Install **nodejs** and **npm** via **[nodejs.org](https://nodejs.org)**.

Check installed versions of **nodejs** and **npm** via running following commands:

```
node -v
npm -v
```

Check project's current **nodejs** and **npm** version from **[package.json](package.json)**.

## Environment Variables

If you don't give **RESPONSE_ENCRYPTION_SECRET**, response encryption mechanism will be disabled automatically.

```applescript
PORT=4004

PROJECT=OTH
MODULE=FileStorageServer
ENVIRONMENT=Local

MONGODB_URI={Database Connection Url}
MONGODB_CONNECTION_LIMIT={MongoDB Connection Limit}

DATABASE_URL={Database Connection Url}
POSTGRESQL_CONNECTION_LIMIT={Postgresql Connection Limit}

CLOUDAMQP_APIKEY={MQ Api Key}
CLOUDAMQP_URL={MQ Connection Url}

FILE_SERVER_QUEUE_CHANNEL=oth_file_queue
ORCHESTRATION_SERVER_QUEUE_CHANNEL=oth_orchestration_queue

REDISCLOUD_URL={Redis Connection Url}
REDIS_CONNECTION_LIMIT={Redis Connection Limit}

ACCESS_TOKEN_SECRET={Access Token Secret}
RESPONSE_ENCRYPTION_SECRET={Response Encryption Secret}
```

For pre-deployment of S3 provider, update **assets/sql/preload.data.json**
with your configuration:

```json
{
  "key": "S3",
  "description": "Amazon S3 Provider",
  "payload": {
    "service": "S3",
    "accessKeyId": "{AWS Access Key Id}",
    "secretAccessKey": "{AWS Secret Key Id}",
    "region": "{S3 Region}",
    "apiVersion": "{API Version}",
    "bucketName": "{S3 Bucket Name}",
    "publicUrl": "{S3 Public Url}"
  }
}
```

For pre-deployment of Google Cloud Storage provider, update **assets/sql/preload.data.json**
with your configuration:

```json
{
  "key": "GCloud",
  "description": "Google Cloud Storage Provider",
  "payload": {
    "service": "GCloud",
    "projectId": "{GCloud Project Id}",
    "clientId": "{GCloud Service User Unique Id}",
    "serviceAccount": "{GCloud Service User Email}",
    "secretAccessKey": "{GCloud Service User Private Key}",
    "bucketName": "{GCloud Bucket Name}",
    "publicUrl": "{GCloud Public Url}"
  }
}
```

## Http Requests

You can find list of available http request in the [requests](assets/requests) directory. You can run http requests directly via **WebStorm**, for more information check out: [jetbrains.com/help/idea/http-client-in-product-code-editor.html](https://jetbrains.com/help/idea/http-client-in-product-code-editor.html)

## Contributors

<table>
 <tr>
 <td align="center"><a href="https://github.com/furknyavuz"><img src="https://avatars0.githubusercontent.com/u/2248168?s=460&u=435ef6ade0785a7a135ce56cae751fb3ade1d126&v=4" width="100px;" alt=""/> Furkan Yavuz</a> <a href="https://github.com/open-template-hub/file-storage-server-template/issues/created_by/furknyavuz" title="Answering Questions">💬</a> <a href="https://github.com/open-template-hub/file-storage-server-template/commits?author=furknyavuz" title="Documentation">📖</a> <a href="https://github.com/open-template-hub/file-storage-server-template/pulls?q=is%3Apr+reviewed-by%3Afurknyavuz" title="Reviewed Pull Requests">👀</a></td>
 <td align="center"><a href="https://github.com/fatihturker"><img src="https://avatars1.githubusercontent.com/u/2202179?s=460&u=261b1129e7106c067783cb022ab9999aad833bdc&v=4" width="100px;" alt=""/> Fatih Turker</a> <a href="https://github.com/open-template-hub/file-storage-server-template/issues/created_by/fatihturker" title="Answering Questions">💬</a> <a href="https://github.com/open-template-hub/file-storage-server-template/commits?author=fatihturker" title="Documentation">📖</a> <a href="https://github.com/open-template-hub/file-storage-server-template/pulls?q=is%3Apr+reviewed-by%3Afatihturker" title="Reviewed Pull Requests">👀</a></td>
 <td align="center"><a href="https://github.com/mertlsarac"><img src="https://avatars1.githubusercontent.com/u/38442589?s=400&u=aa3cda11724fc297a0bfa6beb35c9be81687cf3c&v=4" width="100px;" alt=""/> Mert Sarac</a> <a href="https://github.com/open-template-hub/file-storage-server-template/issues/created_by/mertlsarac" title="Answering Questions">💬</a> <a href="https://github.com/open-template-hub/file-storage-server-template/commits?author=mertlsarac" title="Documentation">📖</a> <a href="https://github.com/open-template-hub/file-storage-server-template/pulls?q=is%3Apr+reviewed-by%3Amertlsarac" title="Reviewed Pull Requests">👀</a></td>
 </tr>
</table>

## Contributing

Refer to **[CONTRIBUTING.md](https://github.com/open-template-hub/.github/blob/master/docs/CONTRIBUTING.md)** to see how to contribute to Open Template Hub.

## Code of Conduct

Refer to **[CODE_OF_CONDUCT.md](https://github.com/open-template-hub/.github/blob/master/docs/CODE_OF_CONDUCT.md)** to see contributor covenant code of conduct.

## LICENSE

The source code for this project is released under the [MIT License](LICENSE).

file-storage-server-template

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README