feat: rest-express-auth example

.github/readmes/_using-the-rest-api-auth.md

@@ -0,0 +1,42 @@
+## Using the REST API
+
+You can access the REST API of the server using the following endpoints:
+
+### `GET`
+
+- `/post/:id`: Fetch a single post by its `id`
+- `/feed?searchString={searchString}&take={take}&skip={skip}&orderBy={orderBy}`: Fetch all _published_ posts
+  - Query Parameters
+    - `searchString` (optional): This filters posts by `title` or `content`
+    - `take` (optional): This specifies how many objects should be returned in the list
+    - `skip` (optional): This specifies how many of the returned objects in the list should be skipped
+    - `orderBy` (optional): The sort order for posts in either ascending or descending order. The value can either `asc` or `desc`s
+- `/user/:id/drafts`: (protected) Fetch user's drafts by their `id`
+- `/users`: Fetch all users
+
+### `POST`
+
+- `/post`: Create a new post
+  - Body:
+    - `title: String` (required): The title of the post
+    - `content: String` (optional): The content of the post
+    - `authorEmail: String` (required): The email of the user that creates the post
+- `/signup`: Create a new user and session
+  - Body:
+    - `email: String` (required): The email address of the user
+    - `password: String` (required): The email of the user
+    - `posts: PostCreateInput[]` (optional): The posts of the user
+- `/login`: Login into account and start a new session
+  - Body:
+    - `email: String` (required): The email address of the user
+    - `password: String` (required): The email of the user
+- `/logout`: Logs out the user and deletes the session
+
+### `PUT`
+
+- `/publish/:id`: Toggle the publish value of a post by its `id`
+- `/post/:id/views`: Increases the `viewCount` of a `Post` by one `id`
+
+### `DELETE`
+
+- `/post/:id`: Delete a post by its `id`

.github/readmes/typescript/rest-express-auth/README.md

@@ -0,0 +1,27 @@
+# REST Authentication API Example
+
+This example shows how to implement a **REST Authentication API with TypeScript** using [Express](https://expressjs.com/) and [Prisma Client](https://www.prisma.io/docs/concepts/components/prisma-client). The example uses an SQLite database file with some initial dummy data which you can find at [`./prisma/dev.db`](./prisma/dev.db).
+
+__INLINE(../_setup-0.md)__
+npx try-prisma@latest --template typescript/rest-express-auth
+__INLINE(../_setup-1.md)__
+cd rest-express-auth
+__INLINE(../_setup-2.md)__
+cd prisma-examples/typescript/rest-express-auth
+__INLINE(../_setup-3.md)__
+
+### 3. Start the REST API server
+
+```
+npm run dev
+```
+
+The server is now running on `http://localhost:3000`. You can now run the API requests, e.g. [`http://localhost:3000/feed`](http://localhost:3000/feed).
+
+__INLINE(../../_using-the-rest-api.md)__
+
+__INLINE(../_evolving-the-app-rest.md)__
+
+__INLINE(../../_switching-databases.md)__
+
+__INLINE(../../_next-steps.md)__

.github/tests/typescript/rest-express-auth/run.sh

@@ -0,0 +1,14 @@
+#!/bin/sh
+
+set -eu
+
+npm install
+npx prisma migrate dev --name init
+npm run dev &
+pid=$!
+
+sleep 20
+
+npx newman run ../../.github/tests/postman_collections/rest.json --bail
+
+kill "$pid"