Skip to content

Commit

Permalink
Init project's document structure
Browse files Browse the repository at this point in the history
  • Loading branch information
Tajcore committed Jul 21, 2020
1 parent 808af6c commit 24c6a63
Show file tree
Hide file tree
Showing 25 changed files with 121 additions and 16 deletions.
Binary file added fonts/Montserrat/Montserrat-Black.ttf
Binary file not shown.
Binary file added fonts/Montserrat/Montserrat-BlackItalic.ttf
Binary file not shown.
Binary file added fonts/Montserrat/Montserrat-Bold.ttf
Binary file not shown.
Binary file added fonts/Montserrat/Montserrat-BoldItalic.ttf
Binary file not shown.
Binary file added fonts/Montserrat/Montserrat-ExtraBold.ttf
Binary file not shown.
Binary file added fonts/Montserrat/Montserrat-ExtraBoldItalic.ttf
Binary file not shown.
Binary file added fonts/Montserrat/Montserrat-ExtraLight.ttf
Binary file not shown.
Binary file added fonts/Montserrat/Montserrat-ExtraLightItalic.ttf
Binary file not shown.
Binary file added fonts/Montserrat/Montserrat-Italic.ttf
Binary file not shown.
Binary file added fonts/Montserrat/Montserrat-Light.ttf
Binary file not shown.
Binary file added fonts/Montserrat/Montserrat-LightItalic.ttf
Binary file not shown.
Binary file added fonts/Montserrat/Montserrat-Medium.ttf
Binary file not shown.
Binary file added fonts/Montserrat/Montserrat-MediumItalic.ttf
Binary file not shown.
Binary file added fonts/Montserrat/Montserrat-Regular.ttf
Binary file not shown.
Binary file added fonts/Montserrat/Montserrat-SemiBold.ttf
Binary file not shown.
Binary file added fonts/Montserrat/Montserrat-SemiBoldItalic.ttf
Binary file not shown.
Binary file added fonts/Montserrat/Montserrat-Thin.ttf
Binary file not shown.
Binary file added fonts/Montserrat/Montserrat-ThinItalic.ttf
Binary file not shown.
93 changes: 93 additions & 0 deletions fonts/Montserrat/OFL.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
Copyright 2011 The Montserrat Project Authors (https://github.com/JulietaUla/Montserrat)

This Font Software is licensed under the SIL Open Font License, Version 1.1.
This license is copied below, and is also available with a FAQ at:
http:https://scripts.sil.org/OFL


-----------------------------------------------------------
SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
-----------------------------------------------------------

PREAMBLE
The goals of the Open Font License (OFL) are to stimulate worldwide
development of collaborative font projects, to support the font creation
efforts of academic and linguistic communities, and to provide a free and
open framework in which fonts may be shared and improved in partnership
with others.

The OFL allows the licensed fonts to be used, studied, modified and
redistributed freely as long as they are not sold by themselves. The
fonts, including any derivative works, can be bundled, embedded,
redistributed and/or sold with any software provided that any reserved
names are not used by derivative works. The fonts and derivatives,
however, cannot be released under any other type of license. The
requirement for fonts to remain under this license does not apply
to any document created using the fonts or their derivatives.

DEFINITIONS
"Font Software" refers to the set of files released by the Copyright
Holder(s) under this license and clearly marked as such. This may
include source files, build scripts and documentation.

"Reserved Font Name" refers to any names specified as such after the
copyright statement(s).

"Original Version" refers to the collection of Font Software components as
distributed by the Copyright Holder(s).

"Modified Version" refers to any derivative made by adding to, deleting,
or substituting -- in part or in whole -- any of the components of the
Original Version, by changing formats or by porting the Font Software to a
new environment.

"Author" refers to any designer, engineer, programmer, technical
writer or other person who contributed to the Font Software.

PERMISSION & CONDITIONS
Permission is hereby granted, free of charge, to any person obtaining
a copy of the Font Software, to use, study, copy, merge, embed, modify,
redistribute, and sell modified and unmodified copies of the Font
Software, subject to the following conditions:

1) Neither the Font Software nor any of its individual components,
in Original or Modified Versions, may be sold by itself.

2) Original or Modified Versions of the Font Software may be bundled,
redistributed and/or sold with any software, provided that each copy
contains the above copyright notice and this license. These can be
included either as stand-alone text files, human-readable headers or
in the appropriate machine-readable metadata fields within text or
binary files as long as those fields can be easily viewed by the user.

3) No Modified Version of the Font Software may use the Reserved Font
Name(s) unless explicit written permission is granted by the corresponding
Copyright Holder. This restriction only applies to the primary font name as
presented to the users.

4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
Software shall not be used to promote, endorse or advertise any
Modified Version, except to acknowledge the contribution(s) of the
Copyright Holder(s) and the Author(s) or with their explicit written
permission.

5) The Font Software, modified or unmodified, in part or in whole,
must be distributed entirely under this license, and must not be
distributed under any other license. The requirement for fonts to
remain under this license does not apply to any document created
using the Font Software.

TERMINATION
This license becomes null and void if any of the above conditions are
not met.

DISCLAIMER
THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
OTHER DEALINGS IN THE FONT SOFTWARE.
3 changes: 3 additions & 0 deletions lib/models/about.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Models are used for collections of data that are used across the app.
If you’ve worked with other languages you can think of them as global structs.
Some examples of what I’ve used is for users data, post information, etc.
6 changes: 6 additions & 0 deletions lib/screens/about.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Screens are just as it sounds. Every screen of the app should have it’s own screen folder.
If its a simple screen, you might just need one file inside that folder.
If it’s a more complex screen I also like to include a local_widgets folder to be used for bigger widgets to keep the code clean.
Since each screen will have it’s own local widgets folder, if there is a widget that is used throughout the app,
then I will place it in the “widgets” folder. I’m a strong believer of never rewriting code.
So if you have multiple screens using the same code, I would recommend putting it into the “widgets” folder.
1 change: 1 addition & 0 deletions lib/services/about.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
This folder is for anything interfacing outside of the application.
1 change: 1 addition & 0 deletions lib/utils/about.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Any functionality that is used throughout the app is stored in this folder
1 change: 1 addition & 0 deletions lib/widgets/about.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Any custom widget throughout the app should be stored in this folder.
32 changes: 16 additions & 16 deletions pubspec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ description: A new Flutter project.

# The following line prevents the package from being accidentally published to
# pub.dev using `pub publish`. This is preferred for private packages.
publish_to: 'none' # Remove this line if you wish to publish to pub.dev
publish_to: "none" # Remove this line if you wish to publish to pub.dev

# The following defines the version and build number for your application.
# A version number is three numbers separated by dots, like 1.2.43
Expand All @@ -24,7 +24,6 @@ dependencies:
flutter:
sdk: flutter


# The following adds the Cupertino Icons font to your application.
# Use with the CupertinoIcons class for iOS style icons.
cupertino_icons: ^0.1.3
Expand All @@ -38,34 +37,35 @@ dev_dependencies:

# The following section is specific to Flutter.
flutter:

# The following line ensures that the Material Icons font is
# included with your application, so that you can use the icons in
# the material Icons class.
uses-material-design: true

# To add assets to your application, add an assets section, like this:
# assets:
# - images/a_dot_burr.jpeg
# - images/a_dot_ham.jpeg

assets:
- assets/
# An image asset can refer to one or more resolution-specific "variants", see
# https://flutter.dev/assets-and-images/#resolution-aware.

# For details regarding adding assets from package dependencies, see
# https://flutter.dev/assets-and-images/#from-packages

# To add custom fonts to your application, add a fonts section here,
# in this "flutter" section. Each entry in this list should have a
# "family" key with the font family name, and a "fonts" key with a
# list giving the asset and other descriptors for the font. For
# example:
# fonts:
# - family: Schyler
# fonts:
# - asset: fonts/Schyler-Regular.ttf
# - asset: fonts/Schyler-Italic.ttf
# style: italic
fonts:
- family: Montserrat
fonts:
- asset: fonts/Montserrat/Montserrat-Regular.ttf
- asset: fonts/Montserrat/Montserrat-Black.ttf
style: black
- asset: fonts/Montserrat/Montserrat-BlackItalic.ttf
style: black-italic
- asset: fonts/Montserrat/Montserrat-Bold.ttf
weight: 700
- asset: fonts/Montserrat/Montserrat-BoldItalic.ttf
style: bold-italic
weight: 700
# - family: Trajan Pro
# fonts:
# - asset: fonts/TrajanPro.ttf
Expand Down

0 comments on commit 24c6a63

Please sign in to comment.