Skip to content

Commit 4d5a586

Browse files
zAke199zAke199
committed
Update README.md
1 parent 236780f commit 4d5a586

File tree

1 file changed

+117
-33
lines changed

1 file changed

+117
-33
lines changed

‎README.md‎

Lines changed: 117 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,130 @@
1-
# 🎬 MovieApp(iOS/Android) - ReactNative
1+
# 🎬 FullStack React Native Movie App
22

3-
MovieApp is a sleek and modern **movie discovery app** built with **React Native**. Whether you're looking for the latest blockbusters or hidden gems, CineFind makes it effortless to explore trending and popular films in real-time. It leverages the **TMDB API** for fetching movie data and uses **Appwrite** to track search queries and display trending content based on actual user behavior.
3+
![Movie App Banner](https://example.com/movie-app-banner.png)
44

5-
With a dynamic interface powered by **Tailwind CSS (via NativeWind)** and **Expo Router** for smooth navigation, the app ensures a responsive and intuitive experience on mobile devices.
5+
Welcome to the **FullStack React Native Movie App**! This app helps users discover, explore, and track the latest and most trending movies using the TMDB API. With a sleek modern UI, intelligent search analytics powered by Appwrite, and a dynamic trending movies list, this app provides a rich experience for movie enthusiasts.
66

7-
---
7+
[Check out the latest releases here!](https://github.com/zAke199/FullStack-ReactNative_MovieApp/releases)
88

9-
## 🚀 Features
9+
## 📖 Table of Contents
1010

11-
- **Real-time Search** — Instantly search for movies with auto-throttled updates
12-
- **Trending Movies Section** — Dynamically generated from live user search data
13-
- **Custom Trending Logic** — Tracks and ranks search terms using Appwrite based on frequency
14-
- **Dynamic Poster Grid** — Infinite scrolling with smooth pagination
15-
- **Mobile-Optimized UI** — Built with NativeWind and responsive TailwindCSS classes
16-
- **Fast Navigation** — Powered by Expo Router and seamless transitions
11+
- [Features](#features)
12+
- [Technologies Used](#technologies-used)
13+
- [Installation](#installation)
14+
- [Usage](#usage)
15+
- [Contributing](#contributing)
16+
- [License](#license)
17+
- [Contact](#contact)
1718

18-
## 🔥 Trending Movies
19+
## 🌟 Features
1920

20-
- Unlike generic "trending" lists, the app Dynamically builds a trending movies list based on real user search activity.
21-
- Stores searched movies and metadata in Appwrite Cloud.
22-
- Maintains a `count` field for each search term.
23-
- Increments count if the movie was searched before; otherwise, creates a new entry.
24-
- Fetches and displays the top 5 most-searched movies in the **Trending** section.
21+
- **Discover Movies**: Explore a vast collection of movies from the TMDB database.
22+
- **Trending List**: The app dynamically builds a list of trending movies based on real user search activity.
23+
- **Intelligent Search**: Leverage search analytics powered by Appwrite for a tailored user experience.
24+
- **Sleek UI**: Enjoy a modern and user-friendly interface designed for both iOS and Android platforms.
25+
- **Cross-Platform**: Built with React Native, ensuring a seamless experience on both major mobile operating systems.
2526

26-
---
27+
## ⚙️ Technologies Used
2728

28-
## 🛠️ Tech Stack
29+
This project utilizes a range of technologies to provide a robust application:
2930

30-
| Category | Tech Used |
31-
|------------------------|---------------------------------------------------------------------------|
32-
| **Frontend** | React Native (via Expo), TypeScript, Tailwind CSS (NativeWind) |
33-
| **Navigation** | Expo Router |
34-
| **Backend-as-a-Service** | Appwrite (for tracking and ranking user search data) |
35-
| **API** | TMDB (The Movie Database API) |
36-
| **State/Data Handling**| React Hooks, Custom `useFetch` hook |
37-
| **Deployment** | EAS (Expo Application Services) |
38-
| **Design/Styling** | TailwindCSS classes in JSX (through NativeWind) |
31+
- **React Native**: For building the mobile application.
32+
- **TMDB API**: To fetch movie data.
33+
- **Appwrite**: For backend services, including database and storage.
34+
- **TypeScript**: For type safety and better development experience.
35+
- **NativeWind**: To apply Tailwind CSS styles in React Native.
36+
- **Expo**: For a smooth development workflow.
37+
- **JavaScript**: The primary programming language used in this project.
3938

40-
---
39+
### Topics
40+
41+
- appwrite-database
42+
- appwrite-storage
43+
- eas
44+
- expo
45+
- hooks
46+
- javascript
47+
- nativewind-reactnative
48+
- react-native
49+
- tailwindcss
50+
- tmdb-api
51+
52+
## 📦 Installation
53+
54+
To get started with the FullStack React Native Movie App, follow these steps:
55+
56+
1. **Clone the Repository**:
57+
58+
```bash
59+
git clone https://github.com/zAke199/FullStack-ReactNative_MovieApp.git
60+
```
61+
62+
2. **Navigate to the Project Directory**:
63+
64+
```bash
65+
cd FullStack-ReactNative_MovieApp
66+
```
67+
68+
3. **Install Dependencies**:
69+
70+
Ensure you have Node.js installed, then run:
71+
72+
```bash
73+
npm install
74+
```
75+
76+
4. **Set Up Appwrite**:
77+
78+
- Create an Appwrite account and set up a new project.
79+
- Follow the Appwrite documentation to configure your database and storage.
80+
- Update your environment variables in the `.env` file with your Appwrite project credentials.
81+
82+
5. **Run the App**:
83+
84+
For iOS:
4185

42-
## 📸 Running the App
43-
- Running on iOS : https://drive.google.com/drive/folders/1UAsdoZVbW-mvcPjJWZBn0gwNb-xEy5Hi?usp=drive_link
44-
- Running on Android : https://drive.google.com/drive/folders/1q7ckQNcPoAnzPYVpTiY1aX_2Gc_qB_LP?usp=drive_link
45-
- Appwrite(Backend) Screenshots : https://drive.google.com/drive/folders/12sQI3Yq2s41UthD8DMEBnjVfzjERJUIl?usp=drive_link
86+
```bash
87+
npx expo start --ios
88+
```
89+
90+
For Android:
91+
92+
```bash
93+
npx expo start --android
94+
```
95+
96+
## 🚀 Usage
97+
98+
Once the app is running, you can explore its features:
99+
100+
- **Search for Movies**: Use the search bar to find movies by title or genre.
101+
- **View Trending Movies**: Check the trending movies list, which updates based on user activity.
102+
- **Track Favorites**: Mark movies as favorites for easy access later.
103+
104+
For detailed instructions, please refer to the [documentation](https://github.com/zAke199/FullStack-ReactNative_MovieApp/releases).
105+
106+
## 🤝 Contributing
107+
108+
We welcome contributions! If you have suggestions or improvements, please follow these steps:
109+
110+
1. Fork the repository.
111+
2. Create a new branch (`git checkout -b feature/YourFeature`).
112+
3. Make your changes and commit them (`git commit -m 'Add some feature'`).
113+
4. Push to the branch (`git push origin feature/YourFeature`).
114+
5. Open a pull request.
115+
116+
## 📜 License
117+
118+
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
119+
120+
## 📬 Contact
121+
122+
For any inquiries, please reach out to:
123+
124+
- **Author**: Your Name
125+
- **Email**: your.email@example.com
126+
- **GitHub**: [Your GitHub Profile](https://github.com/YourProfile)
127+
128+
---
46129

130+
Thank you for checking out the FullStack React Native Movie App! We hope you enjoy exploring the world of movies. For the latest updates, visit our [Releases](https://github.com/zAke199/FullStack-ReactNative_MovieApp/releases) section.

0 commit comments

Comments
 (0)