Skip to content

r00tmeister/autoscriber

Repository files navigation

Autoscriber Application

This is a Nuxt.js application that is containerized using Docker.

Prerequisites

Before you begin, ensure you have met the following requirements:

Setup

Follow these steps to get your development environment set up:

  1. Clone the repository:

    git clone https://github.com/r00tmeister/autoscriber.git
  2. Navigate to the project directory:

    cd autoscriber

Environment Variables

This project uses environment variables for configuration. To set up your environment variables:

  1. Copy the .env.example file in the root directory of the project and rename it to .env:

    cp .env.example .env
  2. Open the .env file and replace the placeholder values with your actual values. For example, replace your_supabase_url with the URL of your Supabase instance, and replace your_supabase_api_key with your actual Supabase API key.

    # .env
    NUXT_ENV_SUPABASE_URL=https://xyzcompany.supabase.co
    NUXT_ENV_SUPABASE_API_KEY=123456789abcdef
  3. Save the .env file. The application will now use the values from this file for its configuration.

Running the Application

To start the application in development mode, run:

docker-compose -p autoscriber up --build

This command builds the Docker image and starts the Docker container. The application will be accessible at http://localhost:3000.

Documentation

For more details on working with Nuxt.js, refer to the Nuxt 3 documentation.

For information on deploying Nuxt.js applications, check out the deployment documentation.

Contributing

We welcome contributions! Please see our Contributing Guidelines for more details.

License

This project is licensed under the MIT License.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published