Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/letsintegreat/Almost-Instagram
https://github.com/letsintegreat/Almost-Instagram
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/letsintegreat/Almost-Instagram
- Owner: letsintegreat
- License: mit
- Created: 2022-10-03T18:51:51.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2022-10-19T21:06:32.000Z (almost 2 years ago)
- Last Synced: 2024-06-07T08:33:09.508Z (3 months ago)
- Language: Dart
- Size: 9.55 MB
- Stars: 5
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-appwrite - Source Code
README
# Almost Instagram
A functional clone of Instagram made using Flutter and Appwrite.
## Features
- UI identical to Instagram (Pages: Launch, Login, Signup, Feed, Explore, New post, Profile).
- Authentication (Login & Signup).
- Post an image with caption.
- Users can see each others' posts.
- Appwrite is used to authenticate users, upload pictures, and store database of posts.
## Screenshots
| 
| 
| 
|
|:-: |:-: |--- |
| 
| 
| 
|
| 
| 
| 
|
| | | |
And no, these screenshots are not of the actual Instagram app lol
## Installation
### Appwrite
Appwrite backend server is designed to run in a container environment. Running your server is as easy as running one command from your terminal. You can either run Appwrite on your localhost using docker-compose or on any other container orchestration tool like Kubernetes, Docker Swarm or Rancher.
The easiest way to start running your Appwrite server is by running our docker-compose file. Before running the installation command make sure you have [Docker](https://www.docker.com/products/docker-desktop) installed on your machine:
### Unix
```bash
docker run -it --rm \
--volume /var/run/docker.sock:/var/run/docker.sock \
--volume "$(pwd)"/appwrite:/usr/src/code/appwrite:rw \
--entrypoint="install" \
appwrite/appwrite:1.0.1
```
### Windows
#### CMD
```cmd
docker run -it --rm ^
--volume //var/run/docker.sock:/var/run/docker.sock ^
--volume "%cd%"/appwrite:/usr/src/code/appwrite:rw ^
--entrypoint="install" ^
appwrite/appwrite:1.0.1
```
#### PowerShell
```powershell
docker run -it --rm ,
--volume /var/run/docker.sock:/var/run/docker.sock ,
--volume ${pwd}/appwrite:/usr/src/code/appwrite:rw ,
--entrypoint="install" ,
appwrite/appwrite:1.0.1
```
Once the Docker installation completes, go to to access the Appwrite console from your browser. Please note that on non-linux native hosts, the server might take a few minutes to start after installation completes.
For advanced production and custom installation, check out our Docker [environment variables](docs/tutorials/environment-variables.md) docs. You can also use our public [docker-compose.yml](https://appwrite.io/docker-compose.yml) file to manually set up and environment.
### Flutter
To build and run this project:
1. Get Flutter [here](https://docs.flutter.dev/get-started/install) if you don't already have it
2. Clone this repository
3. `cd` into the repo folder
4. Run `flutter pub get` to get the dependencies
5. Run `flutter run-android` or `flutter run-ios` to build the app
(Please note that a Mac with XCode is required to build for iOS)
## Setting up appwrite project
We are going to use Appwrite CLI to init the project on appwrite console.
## Install Appwrite CLI
The CLI is packaged both as an [npm module](https://www.npmjs.com/package/appwrite-cli) as well as a [standalone binary](https://github.com/appwrite/sdk-for-cli/releases/latest) for your operating system, making it completely dependency free, platform independent and language agnostic.
## Install with NPM
If you have npm set up, run the command below to install the CLI
```bash
npm install -g appwrite-cli
```
## Install with Script
For a completely dependency-free installation, the CLI also ships with a convenient installation script for your operating system
## MacOS
Using [Homebrew](https://brew.sh/)
```bash
brew tap appwrite/sdk-for-cli https://github.com/appwrite/sdk-for-cli
brew update
brew install --HEAD appwrite
```
or terminal
```bash
curl -sL https://appwrite.io/cli/install.sh | bash
```
## Windows
```powershell
iwr -useb https://appwrite.io/cli/install.ps1 | iex
```
## Linux
```bash
curl -sL https://appwrite.io/cli/install.sh | bash
```
After the installation is complete, verify the install using
```cli
appwrite -v
```
## Setup the project using Appwrite CLI
Before you can use the CLI, you need to login to your Appwrite account using
```cli
appwrite login
```
After you're logged in, the CLI needs to be initialized with your Appwrite project. You can initialize the CLI using:
```cli
appwrite init project
```
Choose `Create a new Appwrite project` and the following prompts will guide you through the setup process, enter `almostinstagram` as the ID for your new project. The init command also creates an **appwrite.json** file representing your Appwrite project.
Create a new database
```cli
appwrite databases create --databaseId postdatabase --name posts
```
Create a new collection
```cli
appwrite databases createCollection --databaseId postdatabase --collectionId postcollection --name posts --permissions 'read(\"any\")' 'write(\"any\")'
```
Create `username` attribute
```cli
appwrite databases createStringAttribute --databaseId postdatabase --collectionId postcollection --key username --size 255 --required true
```
Create `caption` attribute
```cli
appwrite databases createStringAttribute --databaseId postdatabase --collectionId postcollection --key caption --size 255 --required true
```
Create `imageId` attribute
```cli
appwrite databases createStringAttribute --databaseId postdatabase --collectionId postcollection --key imageId --size 255 --required true
```
Create a bucket to store post images
```cli
appwrite storage createBucket --bucketId imagesbucket --name images --permissions 'read(\"any\")' 'write(\"any\")'
```
## `lib/utils/api.dart`
You may need to make some changes in `lib/utils/api.dart`:
**url**: This is the endpoint URL. If you are testing the app on an android studio emulator and appwrite is configured on localhost, then you don't need to change it. Otherwise, you will need to change the hostname to the URL that you set while initiating appwrite.
Rest of the `api.dart` should be left as it is.
## Register the client on your dashboard
Finally, you need to register the flutter app. On appwrite console (http://localhost), choose this project, then under "Platforms" head, choose "Add Platform", choose "New Flutter App", and add the required information for all the platforms you are going to run the app.
**Now your Project is ready to run.**
## File Structure
```bash
.
├── android # android files
├── assets # assets (images)
├── ios # ios files
└── lib
├── models # Custom Models
├── screens
│ └── home_tabs # Tabs for home screen
├── utils # Api info
└── widgets # Custom widgets
```
