You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
> - Redwood requires [Node.js](https://nodejs.org/en/) (=20.x) and [Yarn](https://yarnpkg.com/)
8
-
> - Are you on Windows? For best results, follow our [Windows development setup](https://redwoodjs.com/docs/how-to/windows-development-setup) guide
3
+
Welcome to your new [CedarJS](https://cedarjs.com) project!
9
4
10
5
Start by installing dependencies:
11
6
@@ -20,103 +15,3 @@ yarn redwood dev
20
15
```
21
16
22
17
Your browser should automatically open to [http://localhost:8910](http://localhost:8910) where you'll see the Welcome Page, which links out to many great resources.
23
-
24
-
> **The Redwood CLI**
25
-
>
26
-
> Congratulations on running your first Redwood CLI command! From dev to deploy, the CLI is with you the whole way. And there's quite a few commands at your disposal:
27
-
>
28
-
> ```
29
-
> yarn redwood --help
30
-
> ```
31
-
>
32
-
> For all the details, see the [CLI reference](https://redwoodjs.com/docs/cli-commands).
33
-
34
-
## Prisma and the database
35
-
36
-
Redwood wouldn't be a full-stack framework without a database. It all starts with the schema. Open the [`schema.prisma`](api/db/schema.prisma) file in `api/db` and replace the `UserExample` model with the following `Post` model:
37
-
38
-
```prisma
39
-
model Post {
40
-
id Int @id @default(autoincrement())
41
-
title String
42
-
body String
43
-
createdAt DateTime @default(now())
44
-
}
45
-
```
46
-
47
-
Redwood uses [Prisma](https://www.prisma.io/), a next-gen Node.js and TypeScript ORM, to talk to the database. Prisma's schema offers a declarative way of defining your app's data models. And Prisma [Migrate](https://www.prisma.io/migrate) uses that schema to make database migrations hassle-free:
48
-
49
-
```
50
-
yarn rw prisma migrate dev
51
-
52
-
# ...
53
-
54
-
? Enter a name for the new migration: › create posts
55
-
```
56
-
57
-
> `rw` is short for `redwood`
58
-
59
-
You'll be prompted for the name of your migration. `create posts` will do.
60
-
61
-
Now let's generate everything we need to perform all the CRUD (Create, Retrieve, Update, Delete) actions on our `Post` model:
62
-
63
-
```
64
-
yarn redwood generate scaffold post
65
-
```
66
-
67
-
Navigate to [http://localhost:8910/posts/new](http://localhost:8910/posts/new), fill in the title and body, and click "Save".
68
-
69
-
Did we just create a post in the database? Yup! With `yarn rw generate scaffold <model>`, Redwood created all the pages, components, and services necessary to perform all CRUD actions on our posts table.
70
-
71
-
## Frontend first with Storybook
72
-
73
-
Don't know what your data models look like? That's more than ok—Redwood integrates Storybook so that you can work on design without worrying about data. Mockup, build, and verify your React components, even in complete isolation from the backend:
74
-
75
-
```
76
-
yarn rw storybook
77
-
```
78
-
79
-
Seeing "Couldn't find any stories"? That's because you need a `*.stories.{tsx,jsx}` file. The Redwood CLI makes getting one easy enough—try generating a [Cell](https://redwoodjs.com/docs/cells), Redwood's data-fetching abstraction:
80
-
81
-
```
82
-
yarn rw generate cell examplePosts
83
-
```
84
-
85
-
The Storybook server should hot reload and now you'll have four stories to work with. They'll probably look a little bland since there's no styling. See if the Redwood CLI's `setup ui` command has your favorite styling library:
86
-
87
-
```
88
-
yarn rw setup ui --help
89
-
```
90
-
91
-
## Testing with Jest
92
-
93
-
It'd be hard to scale from side project to startup without a few tests. Redwood fully integrates Jest with both the front- and back-ends, and makes it easy to keep your whole app covered by generating test files with all your components and services:
94
-
95
-
```
96
-
yarn rw test
97
-
```
98
-
99
-
To make the integration even more seamless, Redwood augments Jest with database [scenarios](https://redwoodjs.com/docs/testing#scenarios) and [GraphQL mocking](https://redwoodjs.com/docs/testing#mocking-graphql-calls).
100
-
101
-
## Ship it
102
-
103
-
Redwood is designed for both serverless deploy targets like Netlify and Vercel and serverful deploy targets like Render and AWS:
104
-
105
-
```
106
-
yarn rw setup deploy --help
107
-
```
108
-
109
-
Don't go live without auth! Lock down your app with Redwood's built-in, database-backed authentication system ([dbAuth](https://redwoodjs.com/docs/authentication#self-hosted-auth-installation-and-setup)), or integrate with nearly a dozen third-party auth providers:
110
-
111
-
```
112
-
yarn rw setup auth --help
113
-
```
114
-
115
-
## Next Steps
116
-
117
-
The best way to learn Redwood is by going through the comprehensive [tutorial](https://redwoodjs.com/docs/tutorial/foreword) and joining the community (via the [Discourse forum](https://community.redwoodjs.com) or the [Discord server](https://discord.gg/redwoodjs)).
118
-
119
-
## Quick Links
120
-
121
-
- Stay updated: read [Forum announcements](https://community.redwoodjs.com/c/announcements/5), follow us on [Twitter](https://twitter.com/redwoodjs), and subscribe to the [newsletter](https://redwoodjs.com/newsletter)
122
-
-[Learn how to contribute](https://redwoodjs.com/docs/contributing)
> - Redwood requires [Node.js](https://nodejs.org/en/) (=20.x) and [Yarn](https://yarnpkg.com/)
8
-
> - Are you on Windows? For best results, follow our [Windows development setup](https://redwoodjs.com/docs/how-to/windows-development-setup) guide
3
+
Welcome to your new [CedarJS](https://cedarjs.com) project!
9
4
10
5
Start by installing dependencies:
11
6
@@ -20,103 +15,3 @@ yarn redwood dev
20
15
```
21
16
22
17
Your browser should automatically open to [http://localhost:8910](http://localhost:8910) where you'll see the Welcome Page, which links out to many great resources.
23
-
24
-
> **The Redwood CLI**
25
-
>
26
-
> Congratulations on running your first Redwood CLI command! From dev to deploy, the CLI is with you the whole way. And there's quite a few commands at your disposal:
27
-
>
28
-
> ```
29
-
> yarn redwood --help
30
-
> ```
31
-
>
32
-
> For all the details, see the [CLI reference](https://redwoodjs.com/docs/cli-commands).
33
-
34
-
## Prisma and the database
35
-
36
-
Redwood wouldn't be a full-stack framework without a database. It all starts with the schema. Open the [`schema.prisma`](api/db/schema.prisma) file in `api/db` and replace the `UserExample` model with the following `Post` model:
37
-
38
-
```prisma
39
-
model Post {
40
-
id Int @id @default(autoincrement())
41
-
title String
42
-
body String
43
-
createdAt DateTime @default(now())
44
-
}
45
-
```
46
-
47
-
Redwood uses [Prisma](https://www.prisma.io/), a next-gen Node.js and TypeScript ORM, to talk to the database. Prisma's schema offers a declarative way of defining your app's data models. And Prisma [Migrate](https://www.prisma.io/migrate) uses that schema to make database migrations hassle-free:
48
-
49
-
```
50
-
yarn rw prisma migrate dev
51
-
52
-
# ...
53
-
54
-
? Enter a name for the new migration: › create posts
55
-
```
56
-
57
-
> `rw` is short for `redwood`
58
-
59
-
You'll be prompted for the name of your migration. `create posts` will do.
60
-
61
-
Now let's generate everything we need to perform all the CRUD (Create, Retrieve, Update, Delete) actions on our `Post` model:
62
-
63
-
```
64
-
yarn redwood generate scaffold post
65
-
```
66
-
67
-
Navigate to [http://localhost:8910/posts/new](http://localhost:8910/posts/new), fill in the title and body, and click "Save".
68
-
69
-
Did we just create a post in the database? Yup! With `yarn rw generate scaffold <model>`, Redwood created all the pages, components, and services necessary to perform all CRUD actions on our posts table.
70
-
71
-
## Frontend first with Storybook
72
-
73
-
Don't know what your data models look like? That's more than ok—Redwood integrates Storybook so that you can work on design without worrying about data. Mockup, build, and verify your React components, even in complete isolation from the backend:
74
-
75
-
```
76
-
yarn rw storybook
77
-
```
78
-
79
-
Seeing "Couldn't find any stories"? That's because you need a `*.stories.{tsx,jsx}` file. The Redwood CLI makes getting one easy enough—try generating a [Cell](https://redwoodjs.com/docs/cells), Redwood's data-fetching abstraction:
80
-
81
-
```
82
-
yarn rw generate cell examplePosts
83
-
```
84
-
85
-
The Storybook server should hot reload and now you'll have four stories to work with. They'll probably look a little bland since there's no styling. See if the Redwood CLI's `setup ui` command has your favorite styling library:
86
-
87
-
```
88
-
yarn rw setup ui --help
89
-
```
90
-
91
-
## Testing with Jest
92
-
93
-
It'd be hard to scale from side project to startup without a few tests. Redwood fully integrates Jest with both the front- and back-ends, and makes it easy to keep your whole app covered by generating test files with all your components and services:
94
-
95
-
```
96
-
yarn rw test
97
-
```
98
-
99
-
To make the integration even more seamless, Redwood augments Jest with database [scenarios](https://redwoodjs.com/docs/testing#scenarios) and [GraphQL mocking](https://redwoodjs.com/docs/testing#mocking-graphql-calls).
100
-
101
-
## Ship it
102
-
103
-
Redwood is designed for both serverless deploy targets like Netlify and Vercel and serverful deploy targets like Render and AWS:
104
-
105
-
```
106
-
yarn rw setup deploy --help
107
-
```
108
-
109
-
Don't go live without auth! Lock down your app with Redwood's built-in, database-backed authentication system ([dbAuth](https://redwoodjs.com/docs/authentication#self-hosted-auth-installation-and-setup)), or integrate with nearly a dozen third-party auth providers:
110
-
111
-
```
112
-
yarn rw setup auth --help
113
-
```
114
-
115
-
## Next Steps
116
-
117
-
The best way to learn Redwood is by going through the comprehensive [tutorial](https://redwoodjs.com/docs/tutorial/foreword) and joining the community (via the [Discourse forum](https://community.redwoodjs.com) or the [Discord server](https://discord.gg/redwoodjs)).
118
-
119
-
## Quick Links
120
-
121
-
- Stay updated: read [Forum announcements](https://community.redwoodjs.com/c/announcements/5), follow us on [Twitter](https://twitter.com/redwoodjs), and subscribe to the [newsletter](https://redwoodjs.com/newsletter)
122
-
-[Learn how to contribute](https://redwoodjs.com/docs/contributing)
> - Redwood requires [Node.js](https://nodejs.org/en/) (=20.x) and [Yarn](https://yarnpkg.com/)
8
-
> - Are you on Windows? For best results, follow our [Windows development setup](https://redwoodjs.com/docs/how-to/windows-development-setup) guide
3
+
Welcome to your new [CedarJS](https://cedarjs.com) project!
9
4
10
5
Start by installing dependencies:
11
6
@@ -20,103 +15,3 @@ yarn redwood dev
20
15
```
21
16
22
17
Your browser should automatically open to [http://localhost:8910](http://localhost:8910) where you'll see the Welcome Page, which links out to many great resources.
23
-
24
-
> **The Redwood CLI**
25
-
>
26
-
> Congratulations on running your first Redwood CLI command! From dev to deploy, the CLI is with you the whole way. And there's quite a few commands at your disposal:
27
-
>
28
-
> ```
29
-
> yarn redwood --help
30
-
> ```
31
-
>
32
-
> For all the details, see the [CLI reference](https://redwoodjs.com/docs/cli-commands).
33
-
34
-
## Prisma and the database
35
-
36
-
Redwood wouldn't be a full-stack framework without a database. It all starts with the schema. Open the [`schema.prisma`](api/db/schema.prisma) file in `api/db` and replace the `UserExample` model with the following `Post` model:
37
-
38
-
```prisma
39
-
model Post {
40
-
id Int @id @default(autoincrement())
41
-
title String
42
-
body String
43
-
createdAt DateTime @default(now())
44
-
}
45
-
```
46
-
47
-
Redwood uses [Prisma](https://www.prisma.io/), a next-gen Node.js and TypeScript ORM, to talk to the database. Prisma's schema offers a declarative way of defining your app's data models. And Prisma [Migrate](https://www.prisma.io/migrate) uses that schema to make database migrations hassle-free:
48
-
49
-
```
50
-
yarn rw prisma migrate dev
51
-
52
-
# ...
53
-
54
-
? Enter a name for the new migration: › create posts
55
-
```
56
-
57
-
> `rw` is short for `redwood`
58
-
59
-
You'll be prompted for the name of your migration. `create posts` will do.
60
-
61
-
Now let's generate everything we need to perform all the CRUD (Create, Retrieve, Update, Delete) actions on our `Post` model:
62
-
63
-
```
64
-
yarn redwood generate scaffold post
65
-
```
66
-
67
-
Navigate to [http://localhost:8910/posts/new](http://localhost:8910/posts/new), fill in the title and body, and click "Save".
68
-
69
-
Did we just create a post in the database? Yup! With `yarn rw generate scaffold <model>`, Redwood created all the pages, components, and services necessary to perform all CRUD actions on our posts table.
70
-
71
-
## Frontend first with Storybook
72
-
73
-
Don't know what your data models look like? That's more than ok—Redwood integrates Storybook so that you can work on design without worrying about data. Mockup, build, and verify your React components, even in complete isolation from the backend:
74
-
75
-
```
76
-
yarn rw storybook
77
-
```
78
-
79
-
Seeing "Couldn't find any stories"? That's because you need a `*.stories.{tsx,jsx}` file. The Redwood CLI makes getting one easy enough—try generating a [Cell](https://redwoodjs.com/docs/cells), Redwood's data-fetching abstraction:
80
-
81
-
```
82
-
yarn rw generate cell examplePosts
83
-
```
84
-
85
-
The Storybook server should hot reload and now you'll have four stories to work with. They'll probably look a little bland since there's no styling. See if the Redwood CLI's `setup ui` command has your favorite styling library:
86
-
87
-
```
88
-
yarn rw setup ui --help
89
-
```
90
-
91
-
## Testing with Jest
92
-
93
-
It'd be hard to scale from side project to startup without a few tests. Redwood fully integrates Jest with both the front- and back-ends, and makes it easy to keep your whole app covered by generating test files with all your components and services:
94
-
95
-
```
96
-
yarn rw test
97
-
```
98
-
99
-
To make the integration even more seamless, Redwood augments Jest with database [scenarios](https://redwoodjs.com/docs/testing#scenarios) and [GraphQL mocking](https://redwoodjs.com/docs/testing#mocking-graphql-calls).
100
-
101
-
## Ship it
102
-
103
-
Redwood is designed for both serverless deploy targets like Netlify and Vercel and serverful deploy targets like Render and AWS:
104
-
105
-
```
106
-
yarn rw setup deploy --help
107
-
```
108
-
109
-
Don't go live without auth! Lock down your app with Redwood's built-in, database-backed authentication system ([dbAuth](https://redwoodjs.com/docs/authentication#self-hosted-auth-installation-and-setup)), or integrate with nearly a dozen third-party auth providers:
110
-
111
-
```
112
-
yarn rw setup auth --help
113
-
```
114
-
115
-
## Next Steps
116
-
117
-
The best way to learn Redwood is by going through the comprehensive [tutorial](https://redwoodjs.com/docs/tutorial/foreword) and joining the community (via the [Discourse forum](https://community.redwoodjs.com) or the [Discord server](https://discord.gg/redwoodjs)).
118
-
119
-
## Quick Links
120
-
121
-
- Stay updated: read [Forum announcements](https://community.redwoodjs.com/c/announcements/5), follow us on [Twitter](https://twitter.com/redwoodjs), and subscribe to the [newsletter](https://redwoodjs.com/newsletter)
122
-
-[Learn how to contribute](https://redwoodjs.com/docs/contributing)
0 commit comments