Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement Flume foundation #3

Merged
merged 2 commits into from
Sep 21, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Miscellaneous
*.class
*.log
*.pyc
*.swp
.DS_Store
.atom/
.buildlog/
.history
.svn/
.cache/
migrate_working_dir/

# IntelliJ related
*.iml
*.ipr
*.iws
.idea/

# The .vscode folder contains launch configuration and tasks you configure in
# VS Code which you may wish to be included in version control, so this line
# is commented out by default.
#.vscode/

# Flutter/Dart/Pub related
# Libraries should not include pubspec.lock, per https://dart.dev/guides/libraries/private-files#pubspeclock.
/pubspec.lock
**/doc/api/
.dart_tool/
.packages
build/
10 changes: 10 additions & 0 deletions .metadata
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# This file tracks properties of this Flutter project.
# Used by Flutter tool to assess capabilities and perform upgrades etc.
#
# This file should be version controlled and should not be manually edited.

version:
revision: 4f9d92fbbdf072a70a70d2179a9f87392b94104c
channel: stable

project_type: package
1 change: 1 addition & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
TODO: Add your license here.
39 changes: 39 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
<!--
This README describes the package. If you publish this package to pub.dev,
this README's contents appear on the landing page for your package.
For information about how to write a good package README, see the guide for
[writing package pages](https://dart.dev/guides/libraries/writing-package-pages).
For general information about developing packages, see the Dart guide for
[creating packages](https://dart.dev/guides/libraries/create-library-packages)
and the Flutter guide for
[developing packages and plugins](https://flutter.dev/developing-packages).
-->

TODO: Put a short description of the package here that helps potential users
know whether this package might be useful for them.

## Features

TODO: List what your package can do. Maybe include images, gifs, or videos.

## Getting started

TODO: List prerequisites and provide or point to information on how to
start using the package.

## Usage

TODO: Include short and useful examples for package users. Add longer examples
to `/example` folder.

```dart
const like = 'sample';
```

## Additional information

TODO: Tell users more about the package: where to find more information, how to
contribute to the package, how to file issues, what response they can expect
from the package authors, and more.
5 changes: 5 additions & 0 deletions analysis_options.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
include: package:flutter_lints/flutter.yaml

analyzer:
errors:
invalid_annotation_target: ignore
Binary file added assets/docs/favicon.ico
Binary file not shown.
22 changes: 22 additions & 0 deletions dartdoc_options.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
dartdoc:
ignore:
- ambiguous-doc-reference
- unresolved-doc-reference
errors:
#- unresolved-doc-reference
warnings:
- tool-error
categories:
Flume:
markdown: doc/flume.md
name: Flume
Foundation:
markdown: doc/foundation.md
name: Foundation
Components:
markdown: doc/components.md
name: Components
categoryOrder: [Flume, Foundation, Components]
examplePathPrefix: example/
showUndocumentedCategories: true
favicon: assets/docs/favicon.ico
1 change: 1 addition & 0 deletions doc/components.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Components
14 changes: 14 additions & 0 deletions doc/flume.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Flume

Implementation of Gameflow's Flume design system.

Contains libraries for both the design tokens as well as Flutter implementations of all UI components.

## Getting started

```dart
FlumeApp(
theme: Flume.fallback(),
child: YourApp(),
),
```
12 changes: 12 additions & 0 deletions doc/foundation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Foundation

The Foundation library consists of all Flume's design tokens put together;

- Breakpoints
- Colors
- Motion
- Palette
- Shadows
- Shapes
- Spacing
- Typography
5 changes: 5 additions & 0 deletions lib/flume.dart
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
/// The Flume design system implemented in Dart/Flutter.
library flume;

export 'package:flume/src/foundation.dart';
export 'package:flume/src/components.dart';
Binary file added lib/fonts/FlumeIcons.ttf
Binary file not shown.
3 changes: 3 additions & 0 deletions lib/src/components.dart
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
library components;

export 'package:flume/src/components/icons.dart';
Loading