movie-web/README.md

46 lines
1.4 KiB
Markdown
Raw Normal View History

2021-07-13 17:58:38 +02:00
# movie-web
2022-02-17 18:28:23 +01:00
2021-07-14 00:31:37 +02:00
Small web app for watching movies easily. Check it out at **[movie.squeezebox.dev](https://movie.squeezebox.dev)**.
2021-08-02 13:45:22 +02:00
**[Join the Discord community](https://discord.gg/vXsRvye8BS)**
2021-07-14 00:31:37 +02:00
## Credits
2022-02-17 18:28:23 +01:00
- Thanks to [@JipFr](https://github.com/JipFr) for initial work on [movie-cli](https://github.com/JipFr/movie-cli)
- Thanks to [@mrjvs](https://github.com/mrjvs) for help porting to React, and for the beautiful design
- Thanks to [@JoshHeng](https://github.com/JoshHeng/) for the Cloudflare CORS Proxy and URL routing
2021-07-21 12:19:59 +02:00
## Installation
2022-02-17 18:28:23 +01:00
2021-07-21 12:19:59 +02:00
To run this project locally for contributing or testing, run the following commands:
```
git clone https://github.com/JamesHawkinss/movie-web
cd movie-web
yarn install
yarn start
```
2022-02-17 18:28:23 +01:00
2021-07-21 12:19:59 +02:00
To build production files, simply run `yarn build`.
2021-08-30 12:46:39 +02:00
## Environment
2022-02-17 18:28:23 +01:00
- `REACT_APP_CORS_PROXY_URL` - The Cloudflare CORS Proxy, will be something like `https://PROXY.workers.dev?destination=`
2021-08-30 12:46:39 +02:00
2021-07-21 12:19:59 +02:00
## Contributing
2022-02-17 18:28:23 +01:00
Check out [this project's issues](https://github.com/JamesHawkinss/movie-web/issues) for inspiration for contribution. Pull requests are always welcome.
## Rewrite TODO's
- [ ] Better scraper errors
- [ ] Better no results view
- [ ] Add back link of results view
- [ ] Add results list end
- [ ] Add Brand tag top left
- [ ] Add github and discord top right
- [ ] Store watched percentage
- [ ] Implement movie + series view
- [ ] Add scraper stream method
- [ ] Better looking error boundary