https://github.com/samarth-5/blackbird.ai
BlackBird.AI is an AI-SaaS platform where users can interact with a chatbot for quick and accurate responses, as well as design unique images from prompts. It combines conversational AI and creative tools to enhance user experience and productivity.
https://github.com/samarth-5/blackbird.ai
api api-rest expressjs firebase javascript mongodb nodejs reactjs redux-toolkit saas-application tailwindcss
Last synced: 3 months ago
JSON representation
BlackBird.AI is an AI-SaaS platform where users can interact with a chatbot for quick and accurate responses, as well as design unique images from prompts. It combines conversational AI and creative tools to enhance user experience and productivity.
- Host: GitHub
- URL: https://github.com/samarth-5/blackbird.ai
- Owner: samarth-5
- Created: 2024-05-23T18:57:20.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-28T17:53:59.000Z (5 months ago)
- Last Synced: 2024-12-28T18:26:15.474Z (5 months ago)
- Topics: api, api-rest, expressjs, firebase, javascript, mongodb, nodejs, reactjs, redux-toolkit, saas-application, tailwindcss
- Language: JavaScript
- Homepage: https://blackbird-ai-5.onrender.com/
- Size: 3.45 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
https://github.com/samarth-5/BlackBird.AI/assets/128695366/e8813238-d8dd-4cb1-9657-4fd6af3873e3
# BlackBird.AI
BlackBird.AI is an AI-SaaS platform designed to enhance user experience and productivity through advanced conversational AI and creative tools. Users can interact with a chatbot for quick and accurate responses and generate unique images from text prompts, combining cutting-edge technology with creative capabilities.
## Features
- **Conversational AI**: Engage with a sophisticated chatbot for instant and accurate responses to user queries.
- **Image Generation**: Create unique and customized images from textual prompts using advanced AI models.
- **User Interaction**: Intuitive interface for interacting with the chatbot and designing images.
- **Productivity Tools**: Streamline workflows with AI-powered assistance and creative tools.
## Tech Stack
- **Frontend**:
- **ReactJS**: For building dynamic and interactive user interfaces.
- **TailwindCSS**: For modern and responsive styling.
- **Backend**:
- **Node.js**: JavaScript runtime for building scalable server-side applications.
- **Express.js**: Web framework for creating RESTful APIs.
- **OpenAI API**: For chatbot interactions and image generation (or similar AI services).
- **Database**:
- **MongoDB**: NoSQL database for storing user data and application state.
## Setup Instructions
### Prerequisites
- Node.js (version 14 or higher)
- npm (Node package manager)
- MongoDB (local or cloud)
- Access to OpenAI API or equivalent service for AI functionalities
### Clone the Repository
1. Clone the repository to your local machine:
```bash
git clone https://github.com/samarth-5/blackbird.ai.git
```
2. Navigate into the project directory:
```bash
cd blackbird-ai
```
### Frontend Setup
1. Navigate to the `client` directory:
```bash
cd client
```
2. Install frontend dependencies:
```bash
npm install
```
3. Start the React development server:
```bash
npm run dev
```
4. Build the React application for production:
```bash
npm run build
```
5. Run tests (if any):
```bash
npm test
```
6. Eject the create-react-app configuration (if needed):
```bash
npm run eject
```
### Backend Setup
1. Navigate to the `api` directory:
```bash
cd ../api
```
2. Install backend dependencies:
```bash
npm install
```
3. Configure environment variables. Create a `.env` file in the `api` directory and add the following content:
```env
MONGO_URI=your_mongodb_connection_string
OPENAI_API_KEY=your_openai_api_key
```
4. Start the Node.js server:
```bash
npm start
```
5. Run tests (if any):
```bash
npm test
```
### Running the Application
1. Ensure the backend server is running:
```bash
npm start
```
2. Start the frontend development server:
```bash
npm start
```
3. Open your browser and navigate to `http://localhost:3000` to access the application.
## Scripts
### Backend Scripts
- `npm start`: Starts the backend server.
- `npm test`: Runs backend tests (if any).
### Frontend Scripts
- `npm start`: Starts the React development server.
- `npm run build`: Builds the React application for production.
- `npm test`: Runs frontend tests (if any).
- `npm run eject`: Ejects the create-react-app configuration for custom setup.
## Contributing
Contributions are welcome! Please open issues or submit pull requests to contribute to the project.
## License
MIT License - see the [LICENSE](LICENSE) file for details.
## Contact
For any questions or inquiries, please reach out to [[email protected]](mailto:[email protected]).
---
Happy coding!