80 lines
2.6 KiB
Markdown
80 lines
2.6 KiB
Markdown
<a name="readme-top"></a>
|
|
<br />
|
|
<div align="center">
|
|
|
|
[![LinkedIn][linkedin-logo]][linkedin-url]
|
|
|
|
<a href="https://github.com/xyvs/guessit_app">
|
|
<img src="images/logo.png" width="80" height="80">
|
|
</a>
|
|
|
|
<h3 align="center">guessit</h3>
|
|
|
|
![Flask][flask-logo]
|
|
![Vue][vue-logo]
|
|
![TypeScript][typescript-logo]
|
|
![TailwindCSS][tailwind-logo]
|
|
![Docker][docker-logo]
|
|
![Vercel][vercel-logo]
|
|
![GCP][gcp-logo]
|
|
|
|
|
|
<p align="center">
|
|
A web app that guesses info about a video file based on its filename.
|
|
<br />
|
|
<a href="https://guessit.xyvs.io/"><strong>View Demo »</strong></a>
|
|
</p>
|
|
</div>
|
|
|
|
<!-- ABOUT THE PROJECT -->
|
|
## About The Project
|
|
|
|
[![][product-screenshot]](https://guessit.xyvs.io)
|
|
|
|
A web app that guesses info about a video file based on its filename, this app was made with Vue 3 and Tailwind CSS, the backend its powered by Flask and the python library guessit, it was deployed with Vercel and GCP.
|
|
|
|
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
|
|
|
<!-- GETTING STARTED -->
|
|
## Getting Started
|
|
|
|
This is how to set up your project locally and get a local copy up and running.
|
|
|
|
### Installation
|
|
|
|
|
|
1. Clone the repo
|
|
```sh
|
|
git clone https://github.com/xyvs/guessit_app
|
|
```
|
|
2. Start the docker compose file with th filename `docker-compose.dev.yml`
|
|
```sh
|
|
docker-compose -f docker-compose.dev.yml up
|
|
```
|
|
3. Go to `http://localhost:5000` and enjoy the app.
|
|
|
|
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
|
|
|
<!-- LICENSE -->
|
|
## License
|
|
|
|
Distributed under the MIT License.
|
|
|
|
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
|
|
|
|
|
<!-- MARKDOWN LINKS & IMAGES -->
|
|
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
|
|
|
|
[product-screenshot]: images/screenshot.png
|
|
|
|
[linkedin-logo]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin
|
|
[linkedin-url]: https://www.linkedin.com/in/jofranmtz/
|
|
|
|
[vue-logo]: https://img.shields.io/badge/Vue-black?style=for-the-badge&logo=vuedotjs&logoColor=fff
|
|
[tailwind-logo]: https://img.shields.io/badge/TailwindCSS-black?style=for-the-badge&logo=tailwindcss&logoColor=fff
|
|
[vercel-logo]: https://img.shields.io/badge/Vercel-black?style=for-the-badge&logo=vercel&logoColor=fff
|
|
[typescript-logo]: https://img.shields.io/badge/TypeScript-black?style=for-the-badge&logo=typescript&logoColor=fff
|
|
[flask-logo]: https://img.shields.io/badge/Flask-black?style=for-the-badge&logo=flask&logoColor=fff
|
|
[docker-logo]: https://img.shields.io/badge/Docker-black?style=for-the-badge&logo=docker&logoColor=fff
|
|
[gcp-logo]: https://img.shields.io/badge/GCP-black?style=for-the-badge&logo=googlecloud&logoColor=fff |