1 line
12 KiB
JSON
1 line
12 KiB
JSON
{"repo": "belalmoh/lyriclens", "files": {"README.md": {"b1a339a131365da906648932140c15a54b3ffe04": {"t": 1785747264.9902916, "n": 3370, "h": "6829839ce8ec1216", "c": "# LyricLens\n\nLyricLens is a web application that provides a summary about a song and list the countries mentioned in the lyrics\n\n## Overview\n\nLyricLens is a web application that combines song analysis with geographical insights. The application processes song lyrics to provide concise summaries and identifies any countries referenced within the lyrics. Built with modern technologies like Django and React, it offers a containerized architecture using Docker for easy deployment and development.\n\nThe project is structured with a Django backend API that handles the song analysis logic, and a React frontend that provides an intuitive user interface. The application uses environment variables for configuration and includes comprehensive Makefile commands for streamlined development workflows.\n\n\n## Features\n\n- User-friendly song and artist search functionality through an intuitive web interface\n- Song Summary Generation: Get AI-powered summaries of song lyrics\n- Country Detection: Identify countries mentioned in song lyrics\n- Modern Web Interface: Clean and responsive UI built with React and Tailwind CSS\n- RESTful API: Well-structured backend API for song analysis\n- Containerized Architecture: Easy deployment with Docker\n- Development Tools: Comprehensive Makefile commands for development workflow\n- Search for songs by title and artist name\n- View full lyrics for found songs\n- Generate AI-powered analysis of song lyrics\n- Extract themes, topics, and countries mentioned\n- Cache analysis results for improved performance\n\n\n## Technologies\n\n- Python\n- Django\n- Docker\n- React with TypeScript\n- Tailwind CSS\n- Shadcn UI\n\n\n## Prerequisites\n\n- Docker\n- Node.js\n\n## Setup\n\n1. Clone the repository\n2. Rename `.env.example` to `.env` and set the environment variables with the correct values\n3. Run `make build` to build and run the application using Docker Compose\n4. _(Optional) Run `make run-frontend` to run the frontend application_\n\n## API Documentation\n\nThe API documentation is available at `/docs`.\n\n# Makefile Commands\n```shell\nmake build # Builds and runs the application using Docker Compose\n\nmake run # Runs the application containers without rebuilding\n\nmake run-backend # Runs only the backend container without rebuilding\n\nmake run-frontend # Runs only the frontend application\n\nmake stop # Stops all running containers\n\nmake clean # Stops containers and removes associated volumes\n```\n\n## Setup & Installation\n\n### Prerequisites\n\n- Docker and Docker Compose\n- Git\n\n### Running with Docker (Recommended)\n\n1. Clone the repository:\n ```bash\n git clone https://github.com/yourusername/lyriclens.git\n cd lyriclens\n ```\n\n2. Create a `.env` file from the sample:\n ```bash\n cp sample.env .env\n ```\n\n3. Update the `.env` file with your API keys:\n ```\n DEEPSEEK_API_KEY=your_deepseek_api_key\n ```\n\n4. Build and run the application with Docker Compose:\n ```bash\n make build\n ```\n\n### Development Setup\n\nTo run the backend and frontend separately for development:\n\n1. Start the backend with Redis:\n ```bash\n make run-backend\n ```\n\n2. Start the frontend:\n ```bash\n make run-frontend\n ```\n\n## API Endpoints\n\n- `GET /api/song/search?query={search_term}` - Search for songs\n- `GET /api/song/lyrics?artist_name={artist}&track_name={title}` - Get lyrics for a song\n- `POST /api/song/analyze` - Analyze lyrics (with caching)\n"}, "66f9f287e8f19eec01d699b6e49bda2b2a4e9044": {"t": 1785772021.2453575, "n": 3370, "h": "6829839ce8ec1216", "c": "# LyricLens\n\nLyricLens is a web application that provides a summary about a song and list the countries mentioned in the lyrics\n\n## Overview\n\nLyricLens is a web application that combines song analysis with geographical insights. The application processes song lyrics to provide concise summaries and identifies any countries referenced within the lyrics. Built with modern technologies like Django and React, it offers a containerized architecture using Docker for easy deployment and development.\n\nThe project is structured with a Django backend API that handles the song analysis logic, and a React frontend that provides an intuitive user interface. The application uses environment variables for configuration and includes comprehensive Makefile commands for streamlined development workflows.\n\n\n## Features\n\n- User-friendly song and artist search functionality through an intuitive web interface\n- Song Summary Generation: Get AI-powered summaries of song lyrics\n- Country Detection: Identify countries mentioned in song lyrics\n- Modern Web Interface: Clean and responsive UI built with React and Tailwind CSS\n- RESTful API: Well-structured backend API for song analysis\n- Containerized Architecture: Easy deployment with Docker\n- Development Tools: Comprehensive Makefile commands for development workflow\n- Search for songs by title and artist name\n- View full lyrics for found songs\n- Generate AI-powered analysis of song lyrics\n- Extract themes, topics, and countries mentioned\n- Cache analysis results for improved performance\n\n\n## Technologies\n\n- Python\n- Django\n- Docker\n- React with TypeScript\n- Tailwind CSS\n- Shadcn UI\n\n\n## Prerequisites\n\n- Docker\n- Node.js\n\n## Setup\n\n1. Clone the repository\n2. Rename `.env.example` to `.env` and set the environment variables with the correct values\n3. Run `make build` to build and run the application using Docker Compose\n4. _(Optional) Run `make run-frontend` to run the frontend application_\n\n## API Documentation\n\nThe API documentation is available at `/docs`.\n\n# Makefile Commands\n```shell\nmake build # Builds and runs the application using Docker Compose\n\nmake run # Runs the application containers without rebuilding\n\nmake run-backend # Runs only the backend container without rebuilding\n\nmake run-frontend # Runs only the frontend application\n\nmake stop # Stops all running containers\n\nmake clean # Stops containers and removes associated volumes\n```\n\n## Setup & Installation\n\n### Prerequisites\n\n- Docker and Docker Compose\n- Git\n\n### Running with Docker (Recommended)\n\n1. Clone the repository:\n ```bash\n git clone https://github.com/yourusername/lyriclens.git\n cd lyriclens\n ```\n\n2. Create a `.env` file from the sample:\n ```bash\n cp sample.env .env\n ```\n\n3. Update the `.env` file with your API keys:\n ```\n DEEPSEEK_API_KEY=your_deepseek_api_key\n ```\n\n4. Build and run the application with Docker Compose:\n ```bash\n make build\n ```\n\n### Development Setup\n\nTo run the backend and frontend separately for development:\n\n1. Start the backend with Redis:\n ```bash\n make run-backend\n ```\n\n2. Start the frontend:\n ```bash\n make run-frontend\n ```\n\n## API Endpoints\n\n- `GET /api/song/search?query={search_term}` - Search for songs\n- `GET /api/song/lyrics?artist_name={artist}&track_name={title}` - Get lyrics for a song\n- `POST /api/song/analyze` - Analyze lyrics (with caching)\n"}, "08a4b210bbfff239c83ef27417ee69a6c33969e5": {"t": 1785772025.50867, "n": 2186, "h": "a7cab7e97f2be81b", "c": "# LyricLens\n\nLyricLens is a web application that provides a summary about a song and list the countries mentioned in the lyrics\n\n## Overview\n\nLyricLens is a web application that combines song analysis with geographical insights. The application processes song lyrics to provide concise summaries and identifies any countries referenced within the lyrics. Built with modern technologies like Django and React, it offers a containerized architecture using Docker for easy deployment and development.\n\nThe project is structured with a Django backend API that handles the song analysis logic, and a React frontend that provides an intuitive user interface. The application uses environment variables for configuration and includes comprehensive Makefile commands for streamlined development workflows.\n\n\n## Features\n\n- User-friendly song and artist search functionality through an intuitive web interface\n- Song Summary Generation: Get AI-powered summaries of song lyrics\n- Country Detection: Identify countries mentioned in song lyrics\n- Modern Web Interface: Clean and responsive UI built with React and Tailwind CSS\n- RESTful API: Well-structured backend API for song analysis\n- Containerized Architecture: Easy deployment with Docker\n- Development Tools: Comprehensive Makefile commands for development workflow\n\n\n## Technologies\n\n- Python\n- Django\n- Docker\n- React with TypeScript\n- Tailwind CSS\n- Shadcn UI\n\n\n## Prerequisites\n\n- Docker\n- Node.js\n\n## Setup\n\n1. Clone the repository\n2. Rename `.env.example` to `.env` and set the environment variables with the correct values\n3. Run `make build` to build and run the application using Docker Compose\n4. _(Optional) Run `make run-frontend` to run the frontend application_\n\n## API Documentation\n\nThe API documentation is available at `/docs`.\n\n# Makefile Commands\n```shell\nmake build # Builds and runs the application using Docker Compose\n\nmake run # Runs the application containers without rebuilding\n\nmake run-backend # Runs only the backend container without rebuilding\n\nmake run-frontend # Runs only the frontend application\n\nmake stop # Stops all running containers\n\nmake clean # Stops containers and removes associated volumes\n```\n"}, "98526339efefa7d6b9f0cb00ea3f0ead65354030": {"t": 1785772026.6602106, "n": 2098, "h": "2d0fefeb65903c0e", "c": "# LyricLens\n\nLyricLens is a web application that provides a summary about a song and list the countries mentioned in the lyrics\n\n## Overview\n\nLyricLens is a web application that combines song analysis with geographical insights. The application processes song lyrics to provide concise summaries and identifies any countries referenced within the lyrics. Built with modern technologies like Django and React, it offers a containerized architecture using Docker for easy deployment and development.\n\nThe project is structured with a Django backend API that handles the song analysis logic, and a React frontend that provides an intuitive user interface. The application uses environment variables for configuration and includes comprehensive Makefile commands for streamlined development workflows.\n\n\n## Features\n\n- Song Summary Generation: Get AI-powered summaries of song lyrics\n- Country Detection: Identify countries mentioned in song lyrics\n- Modern Web Interface: Clean and responsive UI built with React and Tailwind CSS\n- RESTful API: Well-structured backend API for song analysis\n- Containerized Architecture: Easy deployment with Docker\n- Development Tools: Comprehensive Makefile commands for development workflow\n\n\n## Technologies\n\n- Python\n- Django\n- Docker\n- React with TypeScript\n- Tailwind CSS\n- Shadcn UI\n\n\n## Prerequisites\n\n- Docker\n- Node.js\n\n## Setup\n\n1. Clone the repository\n2. Rename `.env.example` to `.env` and set the environment variables with the correct values\n3. Run `make build` to build and run the application using Docker Compose\n4. _(Optional) Run `make run-frontend` to run the frontend application_\n\n## API Documentation\n\nThe API documentation is available at `/docs`.\n\n# Makefile Commands\n```shell\nmake build # Builds and runs the application using Docker Compose\n\nmake run # Runs the application containers without rebuilding\n\nmake run-backend # Runs only the backend container without rebuilding\n\nmake run-frontend # Runs only the frontend application\n\nmake stop # Stops all running containers\n\nmake clean # Stops containers and removes associated volumes\n```\n"}}}} |