Skip to content

Commit 048538e

Browse files
authored
[DOCS-3425] README: Fix nits + issues (#1)
1 parent 3437403 commit 048538e

File tree

2 files changed

+18
-16
lines changed

2 files changed

+18
-16
lines changed

.env.example

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
FAUNA_SECRET=secret
2+
FAUNA_ENDPOINT=https://db.fauna.com

README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# Fauna dotnet sample app
1+
# Fauna .NET sample app
22

33
## Overview
44

55
This sample app shows how to use [Fauna](https://fauna.com) in a production application.
66

7-
The app uses dotnet and the [Fauna v10 dotnet
7+
The app uses .NET and the [Fauna v10 .NET
88
driver](https://github.com/fauna/fauna-dotnet) to create HTTP API endpoints for an
99
e-commerce store. You can use the app's API endpoints to manage products,
1010
customers, and orders for the store.
@@ -67,7 +67,7 @@ To run the app, you'll need:
6767
- A [Fauna account](https://dashboard.fauna.com/register). You can sign up for a
6868
free account at https://dashboard.fauna.com/register.
6969

70-
- dotnet 6.0 or later.
70+
- .NET 6.0 or later.
7171

7272
- The [Fauna CLI](https://docs.fauna.com/fauna/current/tools/shell/). To install
7373
the CLI, run:
@@ -83,7 +83,7 @@ docs](https://docs.fauna.com/fauna/current/tools/shell/).
8383

8484
## Setup
8585

86-
1. In your terminal, clone the repo and navigate to the `js-sample-app`
86+
1. In your terminal, clone the repo and navigate to the `dotnet-sample-app`
8787
directory. For example:
8888

8989
```sh
@@ -96,7 +96,7 @@ docs](https://docs.fauna.com/fauna/current/tools/shell/).
9696
[`.fauna-project`](https://docs.fauna.com/fauna/current/tools/shell/#proj-config)
9797
file that contains defaults for the Fauna CLI. The file indicates:
9898

99-
- `ECommerce` is the default database for the project.
99+
- `EcommerceDotnet` is the default database for the project.
100100

101101
- The project stores Fauna Schema Language (FSL) files in the
102102
`schema` directory.
@@ -112,13 +112,13 @@ docs](https://docs.fauna.com/fauna/current/tools/shell/).
112112
[Forgot Password](https://dashboard.fauna.com/forgot-password) workflow.
113113

114114

115-
3. Use the Fauna CLI to create the `ECommerce` database:
115+
3. Use the Fauna CLI to create the `EcommerceDotnet` database:
116116

117117
```sh
118-
fauna create-database --environment='' ECommerce
118+
fauna create-database --environment='' EcommerceDotnet
119119
```
120120

121-
4. Push the FSL files in the `schema` directory to the `ECommerce`
121+
4. Push the FSL files in the `schema` directory to the `EcommerceDotnet`
122122
database:
123123

124124
```sh
@@ -129,10 +129,10 @@ docs](https://docs.fauna.com/fauna/current/tools/shell/).
129129
and user-defined functions (UDFs) defined in the FSL files of the
130130
`schema` directory.
131131

132-
5. Create a key with the `server` role for the `ECommerce` database:
132+
5. Create a key with the `server` role for the `EcommerceDotnet` database:
133133

134134
```sh
135-
fauna create-key --environment='' ECommerce server
135+
fauna create-key --environment='' EcommerceDotnet server
136136
```
137137

138138
Copy the returned `secret`. The app can use the key's secret to authenticate
@@ -156,7 +156,7 @@ docs](https://docs.fauna.com/fauna/current/tools/shell/).
156156
157157
## Run the app
158158
159-
The app runs an HTTP API server. From the root directory, run:
159+
The app runs an HTTP API server. From the `sample-app` directory, run:
160160
161161
```sh
162162
dotnet run
@@ -172,11 +172,11 @@ Once started, the local server is available at http://localhost:5049.
172172
### Make API requests
173173
174174
You can use the endpoints to make API requests that read and write data from
175-
the `ECommerce` database.
175+
the `EcommerceDotnet` database.
176176
177177
For example, with the local server running in a separate terminal tab, run the
178178
following curl request to the `POST /products` endpoint. The request creates a
179-
`Product` collection document in the `ECommerce` database.
179+
`Product` collection document in the `EcommerceDotnet` database.
180180
181181
```sh
182182
curl -v \
@@ -191,8 +191,8 @@ curl -v \
191191
}'
192192
```
193193
194-
195-
## Expand the app
194+
<!-- TODO: Uncomment + update after sample data is done. -->
195+
<!-- ## Expand the app
196196
197197
You can further expand the app by adding fields and endpoints.
198198
@@ -227,7 +227,7 @@ Customer documents and related API responses:
227227
228228
Save `schema/collections.fsl`.
229229
230-
3. Push the updated schema to the `ECommerce` database:
230+
3. Push the updated schema to the `EcommerceDotnet` database:
231231
232232
```sh
233233
fauna schema push

0 commit comments

Comments
 (0)