DocNavigator

Understanding DocNavigator

DocNavigator is an innovative AI-driven chatbot builder crafted to enhance the user experience for product documentation and support websites. It serves as a scalable solution, capable of adapting to the needs of organizations irrespective of their size. By utilizing the data on a company's website, DocNavigator becomes a powerful tool that can manage multiple inquiries simultaneously. This capability significantly saves time, boosts productivity, and enhances overall customer satisfaction.

Setting Up DocNavigator

Getting started with DocNavigator is straightforward. The initial step involves creating a .env file, which acts as a configuration file for the application. To guide you, there is an example provided named example.env. This file requires several key variables to be set up:

• APP_URL: The root address where your application is hosted, such as https://localhost:3000.
• OPENAI_API_KEY: The API key required for accessing OpenAI's services.
• NEXT_PUBLIC_SUPABASE_URL: The URL of your Supabase instance, which you'll need to create for this purpose.
• SUPABASE_SERVICE_ROLE_KEY: The service role key for the Supabase instance.
• APP_SECRET: A secret key used for signing JWT tokens.
• USER_SIGNUP_LIMIT: A figure that denotes the limit for additional sign-ups.
• DATABASE_URL: The connection string for the Supabase database.

Once the .env file is ready, initializing the database is necessary. This can be achieved by running the following command in your terminal:

# Initialize the database
yarn run initDb

This command sets up the essential tables and data within your Supabase database to facilitate smooth operation.

Running DocNavigator

After completing the initial setup, it's time to get DocNavigator up and running. You have two options: running the application via Docker or starting it locally.

Using Docker:

1. Build the Docker image with:

   docker build -t doc-navigator .
   

2. Run the Docker container with:

   docker run -p 3000:3000 doc-navigator
   

Running Locally:

1. Install the necessary dependencies:

   yarn install
   

2. Build the application:

   yarn build
   

3. Start the web application:

   yarn start
   

These steps will make the app available on port 3000, and you can access it by opening your web browser and visiting http://localhost:3000.

Getting Involved

Interested in contributing? DocNavigator welcomes contributions from developers. Here’s how you can participate:

1. Fork the repository on GitHub.
2. Create and check out a new branch using:

   git checkout -b feature/my-new-feature
   

3. Implement the changes or features you wish to add.
4. Commit your changes with:

   git commit -am 'Add some feature'
   

5. Push the changes to your branch:

   git push origin feature/my-new-feature
   

6. Submit a Pull Request for your changes to be reviewed.

Licensing Information

DocNavigator is open-source software licensed under the Apache-2.0 License. For more details, you can review the LICENSE file included in the project repository.

By following these guidelines, users can set up and utilize DocNavigator efficiently, contributing to its development and benefiting from its powerful AI capabilities in managing customer inquiries.