README.md

topick.fyi

Important Links

• Source Code Repository
• UI - production
• UI - staging
• UI - development
• API - production
• CD Repository - production
• CD Repository - staging
• CD Repository - development
• OpenAI API Reference

CI/CD Statuses

Core

Production

Staging

Development

Client

Client - Setup

Install nodejs v18+. Using nvm is the best option.

Then run the setup.sh

./client/scripts/setup.sh

Client - Build

./client/scripts/build.sh

Client - Run

./client/scripts/run.sh

Client - Unit Testing

./client/scripts/unit-test.sh

Client - Integration Testing

./client/scripts/integration-test.sh

Server

Server - Setup

Create a .env file in the server root directory with the following contents:

SERVER_PORT=8080
OPENAI_API_KEY=<set this with the key you got>

Install nodejs v18+. Using nvm is the best option.

Then run the setup.sh

./server/scripts/setup.sh

Server - Build

./server/scripts/build.sh

Server - Run

./server/scripts/run.sh

Server - Unit Testing

./server/scripts/unit-test.sh

Server - Integration Testing

./server/scripts/integration-test.sh