Skip to content

Commit 728f192

Browse files
author
Preben Ludviksen
committed
Added most of initial code
1 parent 87853cc commit 728f192

File tree

123 files changed

+16747
-31
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

123 files changed

+16747
-31
lines changed

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.idea/

LICENSE

+191
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,191 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
Copyright 2016 Tripfinger AS
180+
181+
Licensed under the Apache License, Version 2.0 (the "License");
182+
you may not use this file except in compliance with the License.
183+
You may obtain a copy of the License at
184+
185+
http://www.apache.org/licenses/LICENSE-2.0
186+
187+
Unless required by applicable law or agreed to in writing, software
188+
distributed under the License is distributed on an "AS IS" BASIS,
189+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
190+
See the License for the specific language governing permissions and
191+
limitations under the License.

README.md

+52-31
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,80 @@
11
# 9-projects-layout
22

3-
This is a boilerplate for redistributable React Native components and modules with native code
4-
(iOS & Android). It has unit tests for native code, and integration tests for running on emulators
5-
or devices.
3+
This is a boilerplate for distributable React Native components with native code
4+
(iOS & Android). It has unit tests for native code, and integration tests for automated testing
5+
on emulators or devices. The boilerplate example has a HelloWorld component, and a HelloWorld
6+
module backed by native code.
67

7-
When installed via npm, it also supports automatic linking of native code.
8+
When published and installed via npm, the resulting package supports automatic linking of the native
9+
code. The contained package react-native-helloworld is published, and can be installed/linked like
10+
this:
11+
12+
npm install react-native-helloworld
13+
react-native link react-native-helloworld
814

915
## Explanation
1016

11-
What is a 9 projects layout? It is, as a matter of fact, a project layout consisting of 9
12-
individual sub-projects. But bear with me for a minute, it's not nearly as horrible as it sounds.
17+
For a full explanation of the layout, see
18+
[this article](https://www.benwixen.com/articles/distributing-react-native-components-with-native-code).
1319

14-
When you create a new React Native project, three different projects are created for you: the
15-
JS-code, a Java-project (for Android) and an Objective C-project (for iOS). This layout has
16-
three sets of those projects. The first set contains the component code:
20+
There are 3 sets of 3 projects (JS, Obj-C & Java). The first set is for the component code:
1721

1822
/
1923
/android
2024
/ios
2125

22-
Strictly speaking, this is the only set you need, but if you want your code base to stay stable and
23-
correct, you will want to add some tests.
24-
Since RN components are normally bundled with all source code, we want to keep the
25-
projects as simple as possible. To achieve this, we create a separate set of three projects for
26-
testing:
26+
The second set is for unit- and integration tests:
2727

2828
/tests
2929
/tests/android
3030
/tests/ios
3131

32-
Since these projects link the component code directly, you can do all development from
33-
within these projects in XCode, Android Studio, Webstorm, etc.
34-
35-
The third set of projects are for a sample RN app, demonstrating the component / module in use.
36-
This is of course optional, but a nice feature to have if you want to expand your audience.
32+
The third set is just a sample project to demonstrate usage of the components. The Android and iOS
33+
parts are just the standard React Native boilerplate:
3734

3835
/example
3936
/example/android
4037
/example/ios
4138

4239
## Development
4340

44-
Like mentioned above, you can develop the component code through within the context of the
45-
test-projects. This makes sense because they normally are developed in parallel, and because React
46-
and React Native are peer dependencies of the main project
47-
(meaning they need the context of an app to resolve in your Javascript IDE).
41+
For development of the component code, first run `npm install` in the `tests`-folder. Since the
42+
native code is linked directly in the test-projects, they serve as a context you can develop it in
43+
(the root projects only link React/Native as peer dependencies).
44+
45+
### iOS
46+
47+
If you open `/tests/ios/HelloWorldTests.xcodeproj` in XCode, you can edit the native code and
48+
unit tests side-by-side. You'll find the native code under `Libraries/HelloWorld.xcodeproj`.
49+
Unit- and integration tests can be run together in the standard test-runner with ⌘+U.
50+
51+
### Android
52+
53+
Open `/tests/android` in Android Studio, and you'll find both the native code and the unit tests
54+
in the project view. The unit tests can be run by right-clicking the package containing the tests,
55+
and choosing *Run Tests in tests*.
56+
57+
There is not yet an automatic test runner for integration tests, but you can run them by firing up
58+
`/tests` as a normal React Native app on an Android emulator or device, and selecting the tests
59+
manually from a list.
60+
61+
### JS-code
62+
63+
To develop the JS-components and the integration tests, just open `/tests` in your editor of choice
64+
(f.ex. Atom or WebStorm). The JS-code can be edited from within the `/tests/symlinks`-folder.
65+
Integration tests are located under `/tests/integration-test`.
66+
67+
There is a script `/tests/make-copies.sh` that copies the JS-code from the root project into a
68+
folder `/tests/copies`. This is because the React Native packager doesn't follow symlinks. When
69+
running the integration tests through XCode, this script is run automatically.
4870

49-
## Unit testss
71+
### Example code
5072

51-
The unit tests for iOS run through the standard XCTest framework. On Android they run using JUnit.
52-
The Javascript tests use jest.
73+
If you want to include an example to demonstrate usage of your component, the `/example` folder is
74+
the place for that. Ideally, you only touch the JS-code, and leave the React Native
75+
boilerplate as it is.
5376

54-
## Integration tests
77+
## Publishing
5578

56-
The integration tests run on iOS through a custom React test runner (that is compatible with XCode).
57-
A test-runner for Android is not yet in place, but the tests can be run from the test app, by
58-
running it on an emulator / device.
59-
# 9-project-layout
79+
Once you have finished your components, you can run a normal `npm publish` from the root folder. The
80+
`/tests` and `/example` folders are automatically excluded from the package.

android/.gitignore

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
*.iml
2+
.gradle
3+
/local.properties
4+
/.idea/workspace.xml
5+
/.idea/libraries
6+
.DS_Store
7+
/build
8+
/captures
9+
.externalNativeBuild

android/build.gradle

+61
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
// Top-level build file where you can add configuration options common to all sub-projects/modules.
2+
3+
apply plugin: 'com.android.library'
4+
5+
buildscript {
6+
repositories {
7+
mavenLocal()
8+
jcenter()
9+
maven {
10+
// For developing the library outside the context of the example app, expect `react-native`
11+
// to be installed at `./node_modules`.
12+
url "$projectDir/../node_modules/react-native/android"
13+
}
14+
maven {
15+
// For developing the example app.
16+
url "$projectDir/../../react-native/android"
17+
}
18+
}
19+
dependencies {
20+
classpath 'com.android.tools.build:gradle:2.2.0'
21+
22+
// NOTE: Do not place your application dependencies here; they belong
23+
// in the individual module build.gradle files
24+
}
25+
}
26+
27+
allprojects {
28+
repositories {
29+
mavenLocal()
30+
jcenter()
31+
maven {
32+
// For developing the library outside the context of the example app, expect `react-native`
33+
// to be installed at `./node_modules`.
34+
url "$projectDir/../node_modules/react-native/android"
35+
}
36+
maven {
37+
// For developing the example app.
38+
url "$projectDir/../../react-native/android"
39+
}
40+
}
41+
}
42+
43+
android {
44+
compileSdkVersion 23
45+
buildToolsVersion "23.0.3"
46+
defaultConfig {
47+
minSdkVersion 16
48+
targetSdkVersion 23
49+
versionCode 1
50+
// versionName "1.0"
51+
// testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
52+
}
53+
54+
lintOptions {
55+
disable 'InvalidPackage'
56+
}
57+
}
58+
59+
dependencies {
60+
compile 'com.facebook.react:react-native:+'
61+
}

android/gradle.properties

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Project-wide Gradle settings.
2+
3+
# IDE (e.g. Android Studio) users:
4+
# Gradle settings configured through the IDE *will override*
5+
# any settings specified in this file.
6+
7+
# For more details on how to configure your build environment visit
8+
# http://www.gradle.org/docs/current/userguide/build_environment.html
9+
10+
# Specifies the JVM arguments used for the daemon process.
11+
# The setting is particularly useful for tweaking memory settings.
12+
org.gradle.jvmargs=-Xmx1536m
13+
14+
# When configured, Gradle will run in incubating parallel mode.
15+
# This option should only be used with decoupled projects. More details, visit
16+
# http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects
17+
# org.gradle.parallel=true
52.4 KB
Binary file not shown.

0 commit comments

Comments
 (0)