Skip to content

akballal/WatchVault_Client

Repository files navigation

WatchVault

WatchVault is an open-source application where users can maintain a history of all the movies, series, and other media they have watched. The project leverages modern technologies to deliver an intuitive and user-friendly experience for tracking and managing watched content.

Features

  • Track Watched History: Add movies, series, or any media to your watched list.
  • Search and Filter: Quickly find specific items from your history.

Repository Overview

  • Frontend (this repository): Contains the user interface built with React and Vite.
  • Backend: The backend server handles data management and API endpoints. Find the backend server code here: WatchVault Server.

Getting Started

Follow the steps below to run the project locally.

  1. Clone the repository:
git clone https://github.com/akballal/WatchVault_Client
cd WatchVault_Client
  1. Install dependencies:
npm install
  1. Running the Frontend
    1. Ensure the backend server is running and accessible. See the backend setup instructions here: WatchVault Server.
    2. Update the backend server's URL in the frontend configuration file:
    // src/config/apiConfig.ts
    export const BASE_URL = 'http://localhost:8080';
    1. Start the development server:
    npm run dev
    1. By default, the application will be available at http://localhost:5173.

Running the Application Locally Using Docker

Follow these steps to build and run the application in a Docker container:

  1. Build the Docker Image
docker build -t watchvault-client .
  1. Run the Docker Container
docker run -p 5173:5173 watchvault-client
The application will be available at http://localhost:5173.

Contributing

We welcome contributions! To get started:

1.Fork the repository.
2.Clone your fork locally.
3.Create a new branch for your feature/fix.
4.Commit your changes with descriptive messages.
5.Push to your fork and submit a pull request.

Feedback

Have ideas or suggestions? Feel free to open an issue or reach out!

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages