Saumya-28 / PixelCraft

1 stars 1 forks source link
hacktoberfest hacktoberfest-accepted hacktoberfest2024

PixelCraft

This is a Flutter app that utilizes the Pexels API to fetch photos and display them on the screen. This project is part of Hacktoberfest 2024 and is open to contributions from the community.

Email Banner

Table of Contents

Features

Installation

To get started with this project, follow these steps:

Prerequisites

Setup Instructions

  1. Clone this repository:

    git clone https://github.com/yourusername/flutter-pexels-viewer.git
    cd flutter-pexels-viewer
  2. Install dependencies:

    flutter pub get
  3. Create a .env file in the root of the project and add your pexels API key:

    API_KEY=your_pexels_api_key
  4. Run the app on a simulator/emulator or a real device:

    flutter run

Usage

Pexels API

This app uses the Pexels API to fetch free images. You need to get an API key from Pexels to use this app.

Note: Ensure your usage follows the Pexels API guidelines, as rate limits and other restrictions may apply.

Contributing

We welcome contributions from everyone, especially as part of Hacktoberfest 2024! To contribute:

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature/your-feature-name).
  3. Make your changes and commit (git commit -m 'Add your message here').
  4. Push to your branch (git push origin feature/your-feature-name).
  5. Create a pull request to the main branch.

Hacktoberfest Guidelines

This project is participating in Hacktoberfest 2024! Here’s how you can contribute:

For more details about Hacktoberfest, visit the official site.

License

This project is licensed under the MIT License. See the LICENSE file for details.