-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Upgrade Commoners. Avoid publishing by connecting to generic JSON RES…
…T API
- Loading branch information
1 parent
cbecfd3
commit 627961a
Showing
9 changed files
with
38 additions
and
89 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,20 +1,15 @@ | ||
# commoners-starter-kit | ||
A cross-platform app built using [`commoners`](commoners.dev). | ||
A cross-platform app for testing the [`commoners`](commoners.dev) build tool. | ||
|
||
## Overview | ||
This repository is configured to automatically build and distribute the application and its related services when new changes are pushed to `main`. | ||
|
||
### Distribution Formats | ||
When new changes are pushed to `main`, this application will automatically be built and distributed in the following formats: | ||
- [x] Web — Progressive Web App (PWA) | ||
- [x] Mac | ||
- [x] Windows | ||
- [x] Linux | ||
- [ ] iOS | ||
- [ ] Android | ||
|
||
<!-- The TypeScript service is hosted using [Railway](https://railway.app/), where following considerations apply: | ||
> **Note:** As of November 2023, choosing your [build providers](https://docs.railway.app/deploy/builds#build-providers) is a [Priority Boarding](https://docs.railway.app/reference/priority-boarding) feature, where you'll have to link your Discord account to support this. | ||
1. When registering each service, set the `build` command to something useless (e.g. `node -v`) and run only a single service at a time (e.g. `npm run build -- --service service && npm run launch -- --service service`). | ||
2. For each service, generate a domain in the Networking tab. Paste this into the `commoners.config.ts` file --> | ||
If you'd like to host the services remotely (e.g. on [Railway](https://railway.app/)), please consider the following: | ||
1. You will want to build services using the `commoners build --service tsNode` syntax | ||
2. The build artifacts can be launched using `commoners launch --service tsNode` | ||
3. Paste any generated URLs into the `commoners.config.ts` file in the services `publish.remote` field. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
File renamed without changes.