---

Links to CueMeet Repositories

You can explore all our repositories for additional tools and integrations:

• CueMeet Docs
• CueMeet Control Panel
• Google Meet Bot
• Ms Teams Bot
• Zoom Meet Bot

---

This directory contains the documentation website built using Docusaurus, a modern static website generator.

CueHired Documentation

CueHired is a comprehensive hiring platform that helps organizations manage their recruitment process efficiently. It provides features for job posting, candidate management, interview scheduling, and organization management.

Key Features

• Authentication & Authorization: Secure user authentication and role-based access control
• Organization Management: Manage company profiles and team structures
• Job Management: Create, manage, and track job postings
• Interview Management: Schedule and conduct interviews with candidates

Getting Started

To work with the documentation locally using Docker, you'll docker or compatible tool installed on your system.

1. Build and start all services:

docker-compose up -d

2. Stop all services:

docker-compose down

To work with the documentation locally, you'll need Node.js installed on your system.

1. Install dependencies:

yarn install

2. Start the development server:

yarn start

This will start a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

Available Scripts

• npm start - Start the development server
• npm run build - Build the static website
• npm run serve - Serve the built website locally
• npm run deploy - Deploy the site to production
• npm run clear - Clear the local build cache

Project Structure

backend/
├── src/                    # Source code
│   ├── modules/           # Feature modules
│   ├── database/          # Database configurations and migrations
│   ├── decorators/        # Custom decorators
│   ├── guards/            # Authentication and authorization guards
│   ├── providers/         # Service providers
│   ├── processors/        # Background processors
│   ├── schedulers/        # Scheduled tasks
│   ├── utils/             # Utility functions
│   ├── constants/         # Application constants
│   ├── app.module.ts      # Root application module
│   └── main.ts           # Application entry point
├── test/                  # Test files
├── Dockerfile            # Docker configuration
├── package.json          # Dependencies and scripts
├── tsconfig.json         # TypeScript configuration
└── nest-cli.json         # NestJS CLI configuration

frontend/
├── src/                   # Source code
│   ├── components/        # Reusable UI components
│   ├── pages/            # Page components
│   ├── routes/           # Route definitions
│   ├── store/            # State management
│   ├── hooks/            # Custom React hooks
│   ├── utils/            # Utility functions
│   ├── lib/              # Library configurations
│   ├── graphql/          # GraphQL queries and mutations
│   ├── App.tsx           # Root component
│   └── main.tsx          # Application entry point
├── public/               # Static assets
├── Dockerfile           # Docker configuration
├── package.json         # Dependencies and scripts
├── tsconfig.json        # TypeScript configuration
├── vite.config.ts       # Vite configuration
└── tailwind.config.ts   # Tailwind CSS configuration

📚 Documentation

Detailed documentation is available in the docs directory:

---

🤝 Contributing

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

---

🔐 Security

Please refer to SECURITY.md for information about reporting security vulnerabilities and best practices.

---

🆙 Upgrading

For version compatibility and migration steps, see UPGRADE.md.

---

📜 Code of Conduct

We follow a standard of respectful communication and collaboration. Please review our Code of Conduct before contributing.

---

📝 License

This project is licensed under the GNU General Public License v3.0 (GPL-3.0) — see the LICENSE file for details.

Made with ❤️ by CueCard.ai team