Skip to content

Commit f77f611

Browse files
gbogardgbogard
committed
Improved homepage with CSS modules
1 parent 262b3ae commit f77f611

File tree

24 files changed

+4219
-3250
lines changed

24 files changed

+4219
-3250
lines changed

‎.bsp/sbt.json‎

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎.eslintrc.json‎

Lines changed: 0 additions & 3 deletions
This file was deleted.

‎.gitignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ out
1010

1111
# scala
1212
target
13+
.bsp
14+
.bloop
15+
.metals
1316

1417
# production
1518
build

‎.jvmopts‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
-Dfile.encoding=UTF8
2+
-Xms1G
3+
-Xmx5G
4+
-XX:ReservedCodeCacheSize=500M
5+
-XX:+TieredCompilation
6+
-XX:+UseParallelGC

‎LICENSE‎

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

‎README.md‎

Lines changed: 105 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,108 @@
1-
## sbt project compiled with Scala 3
1+
# Scala 3 / NextJS Starter
22

3-
### Usage
3+
This is a Scala 3 and Next.js template featuring:
4+
- a [next.js](https://nextjs.org/) web application using Scala 3 and
5+
@japgolly's awesome [scalajs-react](https://github.com/japgolly/scalajs-react/)
6+
- a `NextApp` sbt plugin that lets you add more Next.js sub-projects if you need them
7+
- a `server` sbt project for your server-side logic, preconfigured with sbt-revolver
8+
- a `shared` sbt project for sharing bits of code betwwen your next.js app and your back end
9+
(awesome for sharing [Tapir](https://tapir.softwaremill.com/en/latest/) endpoints for example)
410

5-
This is a normal sbt project. You can compile code with `sbt compile`, run it with `sbt run`, and `sbt console` will start a Scala 3 REPL.
11+
## Setup
612

7-
For more information on the sbt-dotty plugin, see the
8-
[scala3-example-project](https://github.com/scala/scala3-example-project/blob/main/README.md).
13+
### Install node dependencies:
14+
15+
```
16+
cd front && npm install
17+
```
18+
19+
Alternatively, you can run it directly from sbt, from the root repository:
20+
21+
```
22+
sbt npmInstall
23+
```
24+
25+
This is provided as a convenience by the `NextApp` plugin. However, running external from appears to
26+
be significantly slower than running them from a terminal, at least on my laptop :(
27+
28+
## Development
29+
30+
### Launch the Next.js dev server
31+
32+
```
33+
cd front && npm run dev
34+
```
35+
36+
Again, if you'd like to run everything from sbt, the `NextApp` plugin provides several sbt commands:
37+
- `startNextServer` to start the dev server in the background. Does nothing if the server is already running.
38+
- `stopNextServer` to stop the dev server
39+
- `show nextServerIsRunning` to check if the dev server is running
40+
41+
42+
### Build the Javascript from Scala.js (and watch for changes):
43+
44+
In another terminal:
45+
46+
```
47+
sbt ~fastLinkJS
48+
```
49+
50+
## Production build
51+
52+
### 1) Build the Javascript from Scala.js (with full optimization):
53+
54+
```
55+
sbt fullLinkJS
56+
```
57+
58+
### 2) Build the Next.js app
59+
60+
```
61+
cd front && npm run build
62+
```
63+
64+
Or, from sbt:
65+
66+
```
67+
sbt nextBuild
68+
```
69+
70+
---
71+
72+
## Q&A
73+
74+
### Why next.js?
75+
76+
Next.js does a lot of things right out-of-the-box, this means that most applications won't need
77+
a custom and complex Webpack config. With this setup, you get these things for free:
78+
- Fast Refresh
79+
- Static generation and server-side rendering of pages
80+
- Easy routing
81+
- CSS modules (see an example of this in `Homepage`)
82+
83+
Sure, you could turn to a more elaborate setup, using GraalVM for SSR, if you needed to, and unlock more
84+
freedom, but this setup should be enough for many use cases.
85+
86+
### How do I add a new page to my Next.js app?
87+
88+
You cannot write Scala code in the `pages/` folder. Scala sources are meant to go in the `src/` folder, and
89+
Scala.js outputs ES6 modules in a single directory (`target/js`).
90+
91+
To add a new page, you need to create a scalajs-react component somewhere in your Scala code, export it,
92+
for example like this:
93+
94+
```scala
95+
// Will export a "Component" value in the "target/js/Homepage.mjs" module
96+
@JSExportTopLevel("Component", "Homepage")
97+
val HomePageJS = Homepage.toJsComponent.raw
98+
```
99+
100+
Then, you can create a `.js` file in `pages/` and re-export your Scala component:
101+
102+
```Javascript
103+
export {Component as default} from '../target/js/Homepage';
104+
```
105+
106+
Take a look at
107+
[scalajs-react's documentation on interoperability](https://github.com/japgolly/scalajs-react/blob/master/doc/INTEROP.md)
108+
for more info.

‎build.sbt‎

Lines changed: 6 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
1-
import org.scalajs.linker.interface.{OutputPatterns, ModuleKind, ModuleSplitStyle}
2-
3-
val scalaJsReactVersion = "2.0.0-RC3"
4-
51
ThisBuild / scalaVersion := "3.0.1"
62

73
lazy val root = project
84
.in(file("."))
5+
.disablePlugins(RevolverPlugin)
6+
.aggregate(front, server)
97
.settings(
108
name := "scala3-nextjs",
119
)
@@ -17,29 +15,14 @@ lazy val shared = crossProject(JSPlatform, JVMPlatform)
1715
.jvmSettings()
1816
.jsSettings()
1917

20-
lazy val backend = project
21-
.in(file("backend"))
18+
lazy val server = project
19+
.in(file("server"))
2220
.dependsOn(shared.jvm)
2321

2422
lazy val front = project
2523
.in(file("front"))
26-
.enablePlugins(ScalaJSPlugin)
27-
.settings(
28-
name := "scala3-nextjs",
29-
scalacOptions += "-language:implicitConversions",
30-
(Compile / fastLinkJS / scalaJSLinkerOutputDirectory) := target.value / "js",
31-
(Compile / fullLinkJS / scalaJSLinkerOutputDirectory) := target.value / "js",
32-
scalaJSLinkerConfig ~= {
33-
// Enable ECMAScript module output.
34-
_.withModuleKind(ModuleKind.CommonJSModule)
35-
// Use .mjs extension.
36-
.withModuleSplitStyle(ModuleSplitStyle.FewestModules)
37-
.withSourceMap(false)
38-
},
39-
libraryDependencies ++= Seq(
40-
"com.github.japgolly.scalajs-react" %%% "core" % scalaJsReactVersion
41-
)
42-
)
24+
.enablePlugins(NextApp)
25+
.disablePlugins(RevolverPlugin)
4326
.dependsOn(shared.js)
4427

4528

‎front/.babelrc‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"presets": ["next/babel"],
3+
"plugins": [],
4+
"ignore": ["**target/"],
5+
"compact": false
6+
}
7+

0 commit comments

Comments
 (0)