diff --git a/.github/workflows/weekly-sync.yml b/.github/workflows/weekly-sync.yml index 36f423f..2948862 100644 --- a/.github/workflows/weekly-sync.yml +++ b/.github/workflows/weekly-sync.yml @@ -19,7 +19,7 @@ jobs: uses: actions/checkout@v4 - name: Use Node.js - uses: actions/setup-node@v2 + uses: actions/setup-node@v4 with: node-version: '20' # Use the version of Node.js that your project uses diff --git a/README.md b/README.md index db9216b..dc67d8e 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,15 @@ This app is a platform for browsing the most popular TV shows online for free. I ## Description +### Features + +- **Browse TV Shows**: Users can explore a wide range of the most popular english TV shows off all time. +- **Search TV Shows**: Users can search for TV shows by name. +- **View the hottest & latest TV Show**: Users can view the hottest and latest TV shows. +- **View TV Show Details**: Users can view the details of a TV show, including the name, description, and the number of seasons. +- **Manage you watch list**: Users can add TV shows to their watch list and remove them from it. +- **View your watch list**: Users can view the TV shows in their watch list. + ### Prerequisites - Node.js (v20.0.0 or later) @@ -14,6 +23,58 @@ This app is a platform for browsing the most popular TV shows online for free. I 1. Clone the repository: ```bash -git clone https://github.com/username/repository.git -cd repository +git clone https://github.com/britzdylan/hotflix.git +cd hotflix +``` + +2. Install the dependencies: + +```bash +npm install +``` + +3. Start the development server: + +```bash +npm start +``` + +4. Open the app in your browser: + +```bash +http://localhost:4173 +``` + +5. To run the tests: + +```bash +npm test:unit ``` + +### Technologies + +- **Vue3**: This app is built with Vue3, a progressive JavaScript framework for building user interfaces. +- **Vite**: This app is built with Vite, a build tool that aims to provide a faster and leaner development experience for modern web projects. +- **Tailwind CSS**: This app uses Tailwind CSS, a utility-first CSS framework for building custom designs. +- **Vitest**: This app uses Vitest, a testing library for Vue3 that provides a simple and fast testing experience. +- **pinia**: This app uses Pinia, a state management library for Vue3 that provides a simple and fast state management experience. + +## Architecture and Design + +- **Components**: This app is built with a component-based architecture, where each component is a self-contained unit that can be reused across the app. + +## Testing + +- **Unit Tests**: This app is tested with unit tests that cover the composables and the state management along with some utility functions. + +## Deployment + +- **Render**: This app is deployed on Render, a cloud platform that provides a simple and fast deployment experience for modern web projects. + +### Roadmap + +- **User Authentication**: Add user authentication to allow users to create an account and log in. + +## Contributing + +Contributions are welcome! Please feel free to submit a pull request.