Skip to content

Commit 42108e6

Browse files
authored
Update README.md
1 parent 38628c4 commit 42108e6

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,18 @@ This can be used for serving a variety of different content, such as JSON data,
1212

1313
The project is built using MSW and can be run directly on a local machine or in Docker containers.
1414

15+
The framework is written in TypeScript and can :
16+
17+
- Serve data from static files (JSON or text)
18+
- Serve media : Images and Videos
19+
- Serve markdown files
20+
- Be used to write and test AWS Lambda Functions
21+
- Use custom middleware to transform input/output
22+
- Serve random Database seed data
23+
- Serve persisted mock data to the database
24+
- Perform CRUD operations on the local database via a REST endpoint
25+
- Mock API error codes/messages for testing frontend error handling logic
26+
1527
## Set-up
1628

1729
Clone the repo or use the template button directly in GitHub to set-up a new repo using this one as a template.
@@ -84,18 +96,6 @@ npm run dev
8496

8597
## Using the Mock API Framework
8698

87-
The framework is written in TypeScript and can :
88-
89-
- Serve data from static files (JSON or text)
90-
- Serve media : Images and Videos
91-
- Serve markdown files
92-
- Be used to write and test AWS Lambda Functions
93-
- Use custom middleware to transform input/output
94-
- Serve random Database seed data
95-
- Serve persisted mock data to the database
96-
- Perform CRUD operations on the local database via a REST endpoint
97-
- Mock API error codes/messages for testing frontend error handling logic
98-
9999
### Setting up a new API route
100100

101101
The system uses file-based routing (similar to NextJS) - simply create a folder in '/api' that is then mapped to an api route with the folder name.

0 commit comments

Comments
 (0)