birdy.ai

Getting Started

Installation

1. Clone the Repository:

git clone https://github.com/kayyueth/birdy_ai
cd birdy_ai

2. Install Dependencies:

npm install

Environment Variables

To configure the application, create and populate the environment variables:

1. Create a .env.local file in the root directory:

touch .env.local

2. Populate the new .env.local file with the following variables:

Variable	Description
NEXT_PUBLIC_SUPABASE_URL	Your Supabase Project URL.
NEXT_PUBLIC_SUPABASE_ANON_KEY	Your Supabase Project API key.
OPENAI_KEY	Your OpenAI API key.
APIFY_TOKEN	Your Apify API token.
COINDAR_API	Your CoinDar API URL with access token.
MAILCHIMP_API_KEY	Your MailChimp API key.
MAILCHIMP_SERVER_PREFIX	Your MailChimp server prefix.

Running the Project

Start the development server:

npm run dev

You can access the appplication in your browser at http://localhost:3000.

Scripts

• npm run dev: Start the development server.
• npm run build: Build the project for production.
• npm run lint: Lint the code with ESLint.
• npm run format: Format the code using Prettier.
• npm run test: Run Vitest testing suite.
• npm run test:full: Run the Vitest testing suite in verbose mode, showing all test names and passing tests.
• npm run test:ui: Run the Vitest interactive testing UI.
• npm run test:watch: Run Vitest testing suite in watch mode.
• npm run test:coverage: Run the Vitest testing suite with coverage reporting.

Contributors

• George Burt • GitHub • LinkedIn
• Tom Haines • GitHub • LinkedIn
• Kay Yu • GitHub
• Mel Zhou • GitHub