Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/javiergold112/react-native-tmdb-ts
https://github.com/javiergold112/react-native-tmdb-ts
Last synced: 10 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/javiergold112/react-native-tmdb-ts
- Owner: javiergold112
- Created: 2024-02-07T04:24:09.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-02-08T03:14:50.000Z (11 months ago)
- Last Synced: 2024-11-05T22:13:40.916Z (about 2 months ago)
- Language: TypeScript
- Size: 653 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# TMDBApp
TMDBApp is a React Native application that showcases trending TV shows and provides lists of popular movies and TV shows using The Movie Database (TMDB) API.
## Features
- View trending TV shows on the Home screen.
- Explore lists of popular movies and TV shows.
- Search functionality for TV shows on the Home screen.
- Navigate to detailed pages for movies and TV shows.
## Prerequisites
Before you begin, ensure you have met the following requirements:
- You have a stable version of [Node.js](https://nodejs.org/) installed.
- You have the React Native development environment set up. For more information, see the [React Native CLI Quickstart](https://reactnative.dev/docs/environment-setup).
- You have an API key from [The Movie Database (TMDB)](https://www.themoviedb.org/documentation/api).
## Installation
To install TMDBApp, follow these steps:
1. Clone the repository:
```bash
git clone https://github.com/deliteser112/TMDBApp.git
```
2. Navigate to the project directory:
```bash
cd TMDBApp
```
3. Install the dependencies:
```bash
npm install
```
4. Create a `.env` file in the root directory and add your TMDB API key:
```env
API_KEY=your_api_key_here
```
## Usage
To run TMDBApp on a simulator or device, follow these steps:
For iOS:
```bash
npx react-native run-ios
```
For Android:
```bash
npx react-native run-android
```
## Running Tests
To run tests, execute the following command:
```bash
npm test
```
## Contributing
Contributions to TMDBApp are welcome. To contribute:
1. Fork the repository.
2. Create a new branch (`git checkout -b feature/your-feature`).
3. Make your changes.
4. Commit your changes (`git commit -m 'Add some feature'`).
5. Push the branch (`git push origin feature/your-feature`).
6. Open a pull request.
Please adhere to this project's code of conduct in your interactions.
## License
This project is licensed under the [MIT License](LICENSE). See the LICENSE file for details.