mirror of
https://github.com/movie-web/movie-web.git
synced 2024-12-27 10:31:48 +01:00
c4f4efe65a
Co-authored-by: Jip Frijlink <JipFr@users.noreply.github.com> Co-authored-by: William Oldham <github@binaryoverload.co.uk>
50 lines
2.7 KiB
Markdown
50 lines
2.7 KiB
Markdown
# Setting up the client
|
|
|
|
## Vercel - Recommended
|
|
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fmovie-web%2Fmovie-web%2Ftree%2Fmaster&env=VITE_CORS_PROXY_URL,VITE_TMDB_READ_API_KEY)
|
|
1. Click the Deploy button.
|
|
1. Sign in using either a GitHub, GitLab, or Bitbucket.
|
|
1. Follow the instructions to create a repository for movie-web.
|
|
1. Configure the environment variables:
|
|
- `VITE_CORS_PROXY_URL`: Enter your proxy URL here. Make sure to not have a slash at the end of your URL.
|
|
|
|
Example (THIS IS AN EXAMPLE, IT WON'T WORK FOR YOU): `https://test-proxy.test.workers.dev`
|
|
- `VITE_TMDB_READ_API_KEY`: Enter your TMDB Read Access Token here. Please read [below](#tmdb-api-key) on how to get an API key.
|
|
1. Click "Deploy"
|
|
1. Congrats! You have your own version of movie-web hosted.
|
|
1. You may wish to configure a custom domain - Please consult [the Vercel docs for how to do this](https://vercel.com/docs/getting-started-with-vercel/domains).
|
|
|
|
|
|
## Any Static Web Host
|
|
1. Download the file `movie-web.zip` from the latest release: https://github.com/movie-web/movie-web/releases/latest.
|
|
2. Extract the ZIP file so you can edit the files.
|
|
3. Open `config.js` in an editor such as Notepad, Visual Studio Code or similar.
|
|
4. Put your proxy URL in-between the double quotes of `VITE_CORS_PROXY_URL: ""`. Make sure to not have a slash at the end of your URL.
|
|
|
|
Example (THIS IS AN EXAMPLE, IT WON'T WORK FOR YOU): `VITE_CORS_PROXY_URL: "https://test-proxy.test.workers.dev"`
|
|
5. Put your TMDB Read Access Token inside the quotes of `VITE_TMDB_READ_API_KEY: ""`. Please read [below](#tmdb-api-key) on how to get an API key.
|
|
6. Save the file.
|
|
7. Upload **all** of the files to a static website hosting such as:
|
|
- GitHub Pages
|
|
- Netlify
|
|
- Vercel
|
|
- Etc, there are lots - Google it if the ones above don't work for you.
|
|
1. Congrats! You have your own version of movie-web hosted.
|
|
|
|
|
|
## TMDB API Key
|
|
In order to search for movies and TV shows, we use an API called "The Movie Database" (TMDB). In order for your client to be able to search, you need to generate an API key.
|
|
|
|
::alert{type="info"}
|
|
The API key is **free**, you just need to create an account.
|
|
::
|
|
|
|
1. Create an account at https://www.themoviedb.org/signup
|
|
1. You will be required to verify your email; click the link that you get sent to verify your account.
|
|
1. Go to https://www.themoviedb.org/settings/api/request to create a developer account.
|
|
1. Read the terms and conditions and accept them.
|
|
1. Fill out your details:
|
|
- Select "Website" as type of use.
|
|
- For the other details can put any values; they are not important.
|
|
1. Copy the "API Read Access Token" - **DO NOT COPY THE API Key - IT WILL NOT WORK**
|