Introduction

• A twitter client for desktop on Linux / FuchsiaOS / MacOS

📒 Index

• About
• Usage
  • Installation
  • Commands
• Development
  • Pre-Requisites
  • Developmen Environment
  • File Structure
  • Build
  • Deployment
• Community
  • Contribution
  • Branches
  • Guideline
• FAQ
• Resources
• Gallery
• Credit/Acknowledgment
• License

🔰 About

This project is a clone of the new twitter UI available for mobile at m.twitter.com

☀️ Usage

flutter run

🔌 Installation

• Connect your device and type flutter run

📦 Commands

• flutter run

🔧 Development

PR are very welcome, improve the docs or create a PR are also great for the project

📓 Pre-Requisites

List all the pre-requisites the system needs to develop this project.

• flutter SDK

🔩 Development Environment

• Refer to flutter.dev to find the instructions to install it on your host machine

📁 File Structure

Add a file structure here with the basic details about files, below is an example.

.
├── README.md
├── analysis_options.yaml
├── assets
│   └── flare
│       ├── ding.flr
│       ├── home.flr
│       ├── home.flr2d
│       ├── message.flr
│       └── search.flr
├── lib
│   ├── main.dart
│   └── scenes
│       ├── home
│       │   ├── screen.dart
│       │   └── widgets
│       │       ├── custom_toolbar.dart
│       │       └── toolbar_button.dart
│       └── widgets
│           └── tweet.dart
├── pubspec.lock
├── pubspec.yaml
├── test
│   └── widget_test.dart
└── twitter.iml

🔨 Build

flutter build

🚀 Deployment

TODO: add instructions

🌸 Community

🔥 Contribution

Your contributions are always welcome and appreciated. Following are the things you can do to contribute to this project.

1. Report a bug
   If you think you have encountered a bug, and I should know about it, feel free to report it here and I will take care of it.

2. Request a feature
   You can also request for a feature here, and if it will viable, it will be picked for development.

3. Create a pull request
   It can't get better then this, your pull request will be appreciated by the community. You can get started by picking up any open issues from here and make a pull request.

If you are new to open-source, make sure to check read more about it here and learn more about creating a pull request here.

🌵 Branches

I use an agile continuous integration methodology, so the version is frequently updated and development is really fast.

1. Master should always be green

2. release-{date} is the stable version of the client.

Steps to create a pull request

1. Make a PR to master branch.
2. It must pass all continuous integration checks and get positive reviews.

After this, changes will be merged.

❗ Guideline

TODO: add guidelines

❓ FAQ

Is this an official twitter client? No, this is a community effort to create a good and performant client

📄 Resources

• fuchsia.dev
• flutter.dev
• m.twitter.com

📷 Gallery

🌟 Credit/Acknowledgment

mishudark 2019

🔒 License

MIT