Installation - davidmarsoni/llog GitHub Wiki

To be able to start and install the project, you will need to follow the main readme file of the project. This file will explain how to install the project and how to run it on your local machine.

https://github.com/davidmarsoni/llog

:cloud: Setup of the cloud part

The following section is a further explanation of the setup of the cloud part of the project. This part goes more deeply into the steps needed to set up the Google Cloud part of the project.

:bucket: Create a google cloud storage bucket

To be able to have a working project, you will need to set up a Google Cloud Storage bucket. This bucket will be used to store the files that you will upload to the project.

To do this, you will have to follow the steps below:

  1. First, you need to select the Google project that you want to use. You can do this by going to the Google Cloud Console. Then you can click on the project name and choose the project that you want to use.

    Google cloud choose project

    If you don't have a project you can create one by clicking on the New project button and follow the steps to create a new project.

  2. Once you have selected your project, you need to search for Cloud Storage in the search bar, then click on create bucket.

    Google cloud create bucket

  3. Follow the steps to create the bucket. You can choose the name of the bucket that you want to use. The name of the bucket must be unique across all google cloud projects. You can choose any name that you want to use.

  4. Once you have created the bucket, you will be able to go to the bucket page and see all the files that you have uploaded to the bucket.

    Google cloud bucket view

:key: Create a service account

To be able to use the Google Cloud bucket when you deploy your project, you need to set up a service account that will be used to access the bucket. To do this, you will have to follow the steps below:

  1. Create your service account by running the command below in your terminal.

    # Grant Storage Object Admin role (for managing objects in buckets)
    gcloud projects add-iam-policy-binding your-project-id \
    --member="serviceAccount:[email protected]" \
    --role="roles/storage.objectAdmin"
    
    # Grant Storage Admin role (for managing buckets)
    gcloud projects add-iam-policy-binding your-project-id \
    --member="serviceAccount:[email protected]" \
    --role="roles/storage.admin"
    
    # Grant service account user role to yourself
    gcloud iam service-accounts add-iam-policy-binding \
    [email protected] \
    --member="user:your-email" \
    --role="roles/iam.serviceAccountUser"
    

N.B: you will need to have the Google Cloud SDK installed on your machine to be able to run the command above.

Then you will have to create the credentials for the service account. To do this, you can follow the steps in the link below:

Google cloud create service account

Once created, you will have to download the JSON file that contains the credentials of the service account. This file will be used to authenticate the service account when you deploy your project. You must put this file in the root of the project and rename it credentials.json.

:scroll: Notion integration token

[!NOTE] Make sure you already have a Notion account. If you don't have one, you can create one by going to the Notion website.

To get the Notion integration token, you will need to create a new integration in your Notion account. To do this, you can follow the steps below:

  1. Go to the Notion integrations page and click on the New integration button.

  2. Give a title of the integration and select the workspace that you want to use.

    Create a integration

  3. Once you have created the integration, you will be able to see the integration token. You will need to copy this token and put it in the .env file in the root of the project.

    Get Integration Token

  4. To be able to access to the Notion pages and databases, you will need to share the pages and databases with the integration. To do this, you can follow the steps below:

    1. Go to the page or database that you want to share with the integration.

    2. Click on the 3 dots on the top right corner of the page and select Connection.

    3. Select the integration that you want to give access to the page or database.

      Notion add integration

:key: OpenAI API key

[!NOTE] Make sure you already have an OpenAI account. If you don't have one, you can create one by going to the OpenAI website.

  1. go to the following link to go to the platform page of OpenAI: OpenAI platform

  2. Create a new project by clicking on the Create project button.

    Create a project

  3. Give a name to the project and click on the Create button.

    Create a project

  4. Once you have created the project, you will be able to see the project page. From there, you can click on the Dashboard tab then click on the API keys tab.

  5. From there, you will be able to see the API keys that you have created. You can create a new API key by clicking on the Create API key button.

    Create API key

:key: Tavily API key

[!NOTE] Make sure you already have a Tavily account. If you don't have one, you can create one by going to the Tavily website.

  1. Go to the home page of Tavily by clicking on the link below : Tavily homepage

  2. Click on the plus button to create a new API key

    Create Tavily API key

  3. Once you have created the API key, you will be able to see the API key. You will need to copy this key and put it in the .env file in the root of the project.

    Get Tavily API key