https://github.com/open-template-hub/analytics-server-template

Analytics Server Template is a generic open-source analytics server that has a simple yet powerful design to connect your business with third-party analytics service providers (like Google Analytics or Matomo).
https://github.com/open-template-hub/analytics-server-template

analysis analysis-algorithms analytics analyzer google-analytics matomo nodejs template

Last synced: 4 months ago
JSON representation

Analytics Server Template is a generic open-source analytics server that has a simple yet powerful design to connect your business with third-party analytics service providers (like Google Analytics or Matomo).

• Host: GitHub
• URL: https://github.com/open-template-hub/analytics-server-template
• Owner: open-template-hub
• License: mit
• Created: 2020-12-27T14:33:52.000Z (almost 5 years ago)
• Default Branch: develop
• Last Pushed: 2024-04-22T04:18:26.000Z (over 1 year ago)
• Last Synced: 2024-05-02T01:38:38.869Z (over 1 year ago)
• Topics: analysis, analysis-algorithms, analytics, analyzer, google-analytics, matomo, nodejs, template
• Language: TypeScript
• Homepage: https://opentemplatehub.com/product/server/analytics-server-template
• Size: 225 KB
• Stars: 9
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          


   

    

  





Open Template Hub - Analytics Server Template v5



[![License](https://img.shields.io/github/license/open-template-hub/analytics-server-template?color=43b043&style=for-the-badge)](LICENSE)

[![Issues](https://img.shields.io/github/issues/open-template-hub/analytics-server-template?color=43b043&style=for-the-badge)](https://github.com/open-template-hub/analytics-server-template/issues)

[![PRCLosed](https://img.shields.io/github/issues-pr-closed-raw/open-template-hub/analytics-server-template?color=43b043&style=for-the-badge)](https://github.com/open-template-hub/analytics-server-template/pulls?q=is%3Apr+is%3Aclosed)

[![LastCommit](https://img.shields.io/github/last-commit/open-template-hub/analytics-server-template?color=43b043&style=for-the-badge)](https://github.com/open-template-hub/analytics-server-template/commits/master)

[![Release](https://img.shields.io/github/release/open-template-hub/analytics-server-template?include_prereleases&color=43b043&style=for-the-badge)](https://github.com/open-template-hub/analytics-server-template/releases)

[![SonarCloud](https://img.shields.io/sonar/quality_gate/open-template-hub_analytics-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_analytics-server-template)

Analytics Server Template is a generic open-source analytics server that has a simple yet powerful design to connect your business with third-party analytics service providers (like Google Analytics or Matomo).

## Ways to Begin

### 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/analytics-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/analytics-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=4005

PROJECT={Project Name}

MODULE={Module Name}

ENVIRONMENT={Environment Name}

MONGODB_URI={Database Connection Url}

MONGODB_CONNECTION_LIMIT={MongoDB Connection Limit}

CLOUDAMQP_APIKEY={MQ Api Key}

CLOUDAMQP_URL={MQ Connection Url}

ANALYTICS_SERVER_QUEUE_CHANNEL={Analytics MQ Channel}

ORCHESTRATION_SERVER_QUEUE_CHANNEL={Orchestration MQ Channel}

REDISCLOUD_URL={Redis Connection Url}

REDIS_CONNECTION_LIMIT={Redis Connection Limit}

ACCESS_TOKEN_SECRET={Access Token Secret}

RESPONSE_ENCRYPTION_SECRET={Response Encryption Secret}

```

## Postman Regression Tests

To be able to configure regression tests, refer to **[REGRESSION_TESTS.md](docs/REGRESSION_TESTS.md)** file.




## 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

  

    
Furkan Yavuz
💬 📖 👀

    
Fatih Turker
💬 📖 👀

    
Mert Sarac
💬 📖 👀

  

## 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).