GetStream / flutter-instagram-clone

An Instagram clone using Flutter and Stream Feeds
113 stars 26 forks source link

Flutter Instagram Clone (Stream-agram)

Pub style: flutter lints Flutter Samples License Stream Feeds

Stream-agram is a demo application showing how to recreate Instagram using Flutter and Stream Feeds.

## Tutorials If you'd like to learn more about this project and how the code is structured, take a look at the companion blog and video. Make sure you're on the [tutorial branch](https://github.com/GetStream/flutter-instagram-clone/tree/tutorial) - this branch is the historic branch that aligns with the tutorial. The `main` branch is the most up to date with the latest code changes and package versions. ```bash git checkout tutorial ``` ### Blog Post - [Article](https://getstream.io/blog/instagram-clone-flutter/) detailing a step-by-step guide for this project. ### YouTube Video - [Video](https://youtu.be/fHRB6KGoaV0) showing how to create this application from start to finish. The video follows the same steps as the blog post, and we recommend that you use both resources to make the tutorial easy to follow. ## Previews

## Supported features - Light and Dark themes. - Instagram-like animations and transitions - Sign in using different user accounts - Add and change profile pictures - Add photo posts to your own user feed (activities) - Subscribe/unsubscribe to other users’ feeds - Add comments and likes (reactions) ## Getting Started These are the steps to run this project locally, with your own Stream Feeds configuration. ### Clone This Repository ``` git clone https://github.com/GetStream/flutter-instagram-clone ``` The project folder needs to be renamed in order for `flutter create` to work (dashes "-" in the folder name are not allowed). You can do this however you want. For example, from a bash terminal you can do: ```bash mv flutter-instagram-clone flutter_instagram_clone ``` ### Create Flutter Platform Folders Run this inside the main folder to generate platform folders. ``` flutter create . ``` ### Setup Image Picker Package Depending on the platform that you're targetting you will need to do some [setup](https://pub.dev/packages/image_picker#installation) for the [image_picker](https://pub.dev/packages/image_picker) Flutter package. At the time of writing this package only supports **Android**, **iOS** and **Web**. ### Add Keys and Tokens You will also need to add your **Stream API-Key** and **User Frontend Tokens**. These are marked with TODOs in the codebase. For additional information, see the [blog](https://getstream.io/blog/instagram-clone-flutter/#creating-demo-instagram-users) or [video](https://www.youtube.com/watch?v=fHRB6KGoaV0&t=627s) section on creating user tokens. ## Stream Feeds Flutter SDK Stream-agram is built with [Stream Feeds](https://getstream.io/activity-feeds/) for implementing activity feeds. - [Activity Feeds Tutorial](https://getstream.io/activity-feeds/sdk/flutter/tutorial/) - Basic tutorials for getting started with activity feeds. - [Stream Feeds Flutter Repository](https://github.com/GetStream/stream-feed-flutter) - Official Flutter SDK for Stream Feeds. - [Feed Client Documentation](https://getstream.io/activity-feeds/docs/flutter-dart/?language=dart) - Detailed documentation of the Activity Feeds client. ## Stream Chat Flutter SDK If you're interested in adding chat functionality to your Instagram clone, check out [Stream Chat](https://getstream.io/chat/). - [Chat Messaging Tutorial](https://getstream.io/chat/flutter/tutorial/) - Basic tutorials for getting started by building a simple messaging app. - [Stream Chat Flutter repository](https://github.com/GetStream/stream-chat-flutter) - Official Flutter SDK for Stream Chat. - [Chat Client Documentation](https://getstream.io/chat/docs/flutter-dart/?language=dart) - Full documentation of the Chat client for requesting API calls. - [Chat UI Components Documentation and Guides](https://getstream.io/chat/docs/sdk/flutter/) - Full documentation of the Stream UI Components. - [Sample Application](https://github.com/GetStream/flutter-samples/tree/main/packages/stream_chat_v1) - Official Flutter sample chat application. ## Find this repository useful? 💙 Support it by joining __[stargazers](https://github.com/GetStream/flutter-instagram-clone/stargazers)__ :star:
# License ```xml Copyright 2021 Stream.IO, Inc. All Rights Reserved. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ```