https://github.com/thefeij/movie-search-api
Movie Search API to search for information about movies
https://github.com/thefeij/movie-search-api
docker elasticsearch godoc golang kubernetes makefile redis-cache unit-testing
Last synced: 4 months ago
JSON representation
Movie Search API to search for information about movies
- Host: GitHub
- URL: https://github.com/thefeij/movie-search-api
- Owner: TheFeij
- Created: 2024-04-12T09:49:14.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-05-02T07:42:58.000Z (about 1 year ago)
- Last Synced: 2025-01-05T09:30:40.069Z (5 months ago)
- Topics: docker, elasticsearch, godoc, golang, kubernetes, makefile, redis-cache, unit-testing
- Language: Go
- Homepage:
- Size: 292 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Movie Search API
## Introduction
The Movie Search project provide an API for searching movies. It offers a functionality to search for movies and retrieve detailed information about them.
## Components
- **API**: Handles HTTP requests and interacts with other services.
- **Elasticsearch**: Contains information about top 1000 imdb movies.
- **Redis**: Caches requested data.
- **RapidAPI**: Integrates with rapidapi's movie search api.
## Prerequisites
Ensure you have the following dependencies installed:
- Docker
- Kubernetes (for deployment)
## Setup
1. Clone the repository:
```
git clone https://github.com/TheFeij/Movie-Search-API
```
2. Navigate to the project directory:
```
cd Movie_Search_API
```
3. Start Docker containers:
```
docker-compose up
```
4. Deploy Kubernetes resources:
```
kubectl apply -f kubernetes/
```
## Usage
- Access the API at `http://localhost:8080` when using docker compose.
- When deployed with Kubernetes, access the API using the Kubernetes cluster IP and port 30000.
- Use the `/search` endpoint to search for movies.
### Example Queries:
1. Search your queries:
- Endpoint: `/search?query=avatar`
- This query will return movies and series related to "avatar"
## Development
- To run tests, use `make test`.
- Check individual component directories for specific test instructions.
- To generate and view the Go documentation, run `make godoc` and access it at `http://localhost:6060`.
## Contributing
Contributions are welcome! Feel free to open issues or pull requests.