Giter Club home page Giter Club logo

frize's Introduction

f r i z e

A free and open-source dashboard for users of Rize (a time tracker that logs your computer usage).

frize

Frize transforms your data into beautiful graphs and charts to help you visualise and gain insights into your productivity. Additionally, it also lets you search through your data and have a conversation with it using natural language powered by GPT.

Tech Stack

  • Next.js
  • Tailwind CSS
  • Tremor UI
  • Supabase
  • OpenAI
  • Vercel

How to set up and run the project?

Prerequisites

  • Node.js: Make sure you have Node.js installed. You can download it from nodejs.org.
  • npm
    npm install npm@latest -g
  • Supabase: Create a project on supabase.com and get your SUPABASE_URL and SUPABASE_SERVICE_KEY.
  • OpenAI: Create an account on openai.com and get your OPENAI_KEY.
  • Data collection: Setup and the run the companion python script for collecting data from your email.

Installation

  1. Clone this repository on your local machine

    git clone https://github.com/rittikbasu/frize.git
  2. Navigate to the project directory

    cd frize
  3. Install the dependencies

    npm install
  4. Create a .env file in the root directory and add the following keys:

    NEXT_PUBLIC_SUPABASE_URL=YOUR_SUPABASE_URL
    SUPABASE_SERVICE_KEY=YOUR_SUPABASE_SERVICE_KEY
    OPENAI_KEY=YOUR_OPENAI_KEY
    STATIC_IP=YOUR_STATIC_IP

    Note: Using a static IP lets you restrict access to certain parts of the website for visitors. If you don't have one no worries just set it to 0.

  5. Run the development server

    npm run dev
  6. Open http://localhost:3000 with your browser to see the result.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

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.