Giter Club home page Giter Club logo

openperf-page's Introduction

OpenPerf Page

Google Analytics Stats page from OpenPerf

Getting Started

In order to access the site's google analytics data, you need to create a service account and provide read access in GA.

Refer Service accounts for more details.

TLDR:

  • Create a project in console.developers.google.com
  • Open IAM Settings -> Credentials -> Service Account
  • Create a service account. On creating a service account, You'll receive the private key and client email.
  • Add both to environment variables
  • Open analytics.google.com and navigate to Admin, to provide read permissions for the generated client email.

Environment Variables

PRIVATE_KEY=
CLIENT_EMAIL=
VIEW_ID=
SITENAME=
GA=
Property Description
PRIVATE_KEY Key for the Service account
CLIENT_EMAIL Email assigned for the service account
VIEW_ID View ID for the Google Analytics Property
SITENAME Name of the site - string
GA UA ID for this page - optional

Deploy

Since the project uses NextJS under the hood, Vercel is the ideal platform to deploy the project. If you'd like to deploy it elsewhere, check this out.

Local Development

In order to run the project locally, clone the repository and create .env file with the environment variables mentioned above. And start the server.

npm run dev
# or
yarn dev

Open http://localhost:3000 with your browser to see the result.

Setup too hard?

Head over to OpenPerf to get your custom dashboard without any setup.

Credits

Project by apvarun

openperf-page's People

Contributors

apvarun avatar

Stargazers

 avatar

Watchers

 avatar  avatar  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.