Skip to content

Commit c89cff8

Browse files
docs: provide steps in README
1 parent a03ba2d commit c89cff8

File tree

1 file changed

+87
-0
lines changed

1 file changed

+87
-0
lines changed

templates/react-ts-example/README.md

+87
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,93 @@ npm create juno@latest -- --template react-example
1010

1111
An example developed for [Juno](https://juno.build) using [React](https://react.dev).
1212

13+
## 🧭 Getting Started
14+
15+
To start experimenting with Juno locally, follow these steps:
16+
17+
### 1. Start the local development emulator
18+
19+
This will spin up the Juno backend locally (requires Docker):
20+
21+
```bash
22+
juno dev start
23+
```
24+
25+
### 2. Create a Satellite
26+
27+
Your project needs a Satellite. Create one to connect your app for development.
28+
29+
👉 [Open the Juno Console](http://localhost:5866)
30+
31+
### 3. Configure your project
32+
33+
Set the Satellite ID in your `juno.config.ts` file:
34+
35+
```ts
36+
import { defineConfig } from "@junobuild/config";
37+
38+
export default defineConfig({
39+
satellite: {
40+
ids: {
41+
development: "<DEV_SATELLITE_ID>",
42+
},
43+
source: "dist",
44+
predeploy: ["npm run build"],
45+
},
46+
});
47+
```
48+
49+
### 4. Start the frontend dev server
50+
51+
In another terminal, start your app's dev server:
52+
53+
```bash
54+
npm run dev
55+
```
56+
57+
### 5. Create a Datastore collection
58+
59+
This template is a note-taking app, so it needs a `notes` collection. Create it in the Datastore.
60+
61+
👉 [Go to Datastore](http://localhost:5866/datastore)
62+
63+
### 6. Create a Storage collection
64+
65+
Likewise, it needs a collection named `images` to save assets. Create it in the Storage.
66+
67+
👉 [Go to Storage](http://localhost:5866/storage)
68+
69+
You only need to do this once. After that, you're ready to build 🚀
70+
71+
### 1. Create a Satellite
72+
73+
Juno uses a dev canister called a **Satellite** to emulate your backend locally.
74+
75+
👉 [Open the Juno Console](http://localhost:5866) to create a new Satellite for testing.
76+
77+
## 🛰️ Production
78+
79+
Ready to go live?
80+
81+
Just like for local development, you'll need to create a Satellite — but this time on the mainnet [Console](https://console.juno.build). Then, update your `juno.config.ts` with the new Satellite ID:
82+
83+
```ts
84+
import { defineConfig } from "@junobuild/config";
85+
86+
export default defineConfig({
87+
satellite: {
88+
ids: {
89+
development: "<DEV_SATELLITE_ID>",
90+
production: "<PROD_SATELLITE_ID>",
91+
},
92+
source: "dist",
93+
predeploy: ["npm run build"],
94+
},
95+
});
96+
```
97+
98+
Check out the full guides in the [docs](https://juno.build/docs/category/deployment).
99+
13100
## ✨ Links & Resources
14101

15102
- Looking to get started with Juno? Check out the [documentation](https://juno.build).

0 commit comments

Comments
 (0)