Writer's Muse is an AI-powered platform designed to assist users in generating high-quality content. It features a range of services, including authentication, chat functionalities, and AI content generation using the LLaMA model. This repository contains the backend code for the platform.
Writer's Muse provides a comprehensive solution for content generation, combining a robust backend with a user-friendly frontend. The backend services are built using TypeScript, while the frontend leverages React JavaScript.
- Authentication: Secure user authentication with token-based sessions.
- AI Content Generation: Integration with the LLaMA model to generate content based on user prompts.
- Chat Functionality: Real-time chat capabilities allowing for interactive conversations with the AI.
Handles user authentication, including registration, login, and token management.
-
Endpoints:
POST /auth/register: Register a new user.POST /auth/login: Authenticate a user and issue a token.POST /auth/refresh: Refresh an authentication token.
-
Dependencies:
express: Web framework.jsonwebtoken: Token management.bcryptjs: Password hashing.
Integrates with the LLaMA model to generate content based on user prompts.
-
Endpoints:
POST /llama/generate: Generate content using the LLaMA model.
-
Dependencies:
axios: HTTP requests.ThetaEdgeCloud: LLaMA 3 8B model integration.
Manages chat interactions, including storing and retrieving chat messages and handling conversation states.
-
Endpoints:
POST /chats/message: Send a new chat message.GET /chats/:conversationId/:userId: Retrieve chat history for a specific conversation.
-
Dependencies:
mongoose: MongoDB object modeling.jsonwebtoken: Token management.
The frontend is built with React and handles user interactions with the platform.
-
Components:
- Auth Forms: Login, registration, and password recovery forms.
- Dashboard: Main interface for interacting with the AI and viewing chat history.
- Splash Screen: Initial loading screen with animated logo.
-
Dependencies:
react: UI library.react-router-dom: Routing.axios: HTTP requests.
To get started with the project, follow these steps:
-
Clone the repository:
git clone https://github.com/anthony-okoye/writers-muse-frontend.git