-### See how *the exact same* Medium.com clone (called [Conduit](https://demo.realworld.io)) is built using different [frontends](https://codebase.show/projects/realworld?category=frontend) and [backends](https://codebase.show/projects/realworld?category=backend). Yes, you can mix and match them, because **they all adhere to the same [API spec](https://realworld-docs.netlify.app/docs/specs/backend-specs/introduction)** ๐ฎ๐
+### See how _the exact same_ Medium.com clone (called [Conduit](https://demo.realworld.io)) is built using different [frontends](https://codebase.show/projects/realworld?category=frontend) and [backends](https://codebase.show/projects/realworld?category=backend). Yes, you can mix and match them, because **they all adhere to the same [API spec](https://realworld-docs.netlify.app/docs/specs/backend-specs/introduction)** ๐ฎ๐
While most "todo" demos provide an excellent cursory glance at a framework's capabilities, they typically don't convey the knowledge & perspective required to actually build _real_ applications with it.
**RealWorld** solves this by allowing you to choose any frontend (React, Angular, & more) and any backend (Node, Django, & more) and see how they power a real-world, beautifully designed full-stack app called [**Conduit**](https://demo.realworld.io).
-*Read the [full blog post announcing RealWorld on Medium.](https://medium.com/@ericsimons/introducing-realworld-6016654d36b5)*
+_Read the [full blog post announcing RealWorld on Medium.](https://medium.com/@ericsimons/introducing-realworld-6016654d36b5)_
Join us on [GitHub Discussions!](https://github.com/gothinkster/realworld/discussions) ๐
@@ -51,5 +50,4 @@ Gรฉrรดme is a Software Engineer at Sfeir. He's an open-source enthusiast.< Manuel is an independent Software Engineer, creator of the [Layr framework](https://layrjs.com) and the [CodebaseShow website](https://codebase.show/).
- [](https://thinkster.io) diff --git a/api/Conduit.postman_collection.json b/api/Conduit.postman_collection.json index c387b73ac..a539e3cca 100644 --- a/api/Conduit.postman_collection.json +++ b/api/Conduit.postman_collection.json @@ -1,22 +1,22 @@ { - "info":{ - "_postman_id":"0574ad8a-a525-43ae-8e1e-5fd9756037f4", - "name":"Conduit", - "description":"Collection for testing the Conduit API\n\nhttps://github.com/gothinkster/realworld", - "schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json" + "info": { + "_postman_id": "0574ad8a-a525-43ae-8e1e-5fd9756037f4", + "name": "Conduit", + "description": "Collection for testing the Conduit API\n\nhttps://github.com/gothinkster/realworld", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, - "item":[ + "item": [ { - "name":"Auth", - "item":[ + "name": "Auth", + "item": [ { - "name":"Register", - "event":[ + "name": "Register", + "event": [ { - "listen":"test", - "script":{ - "type":"text/javascript", - "exec":[ + "listen": "test", + "script": { + "type": "text/javascript", + "exec": [ "if (!(environment.isIntegrationTest)) {", "var responseJSON = JSON.parse(responseBody);", "", @@ -35,44 +35,38 @@ } } ], - "request":{ - "method":"POST", - "header":[ + "request": { + "method": "POST", + "header": [ { - "key":"Content-Type", - "value":"application/json" + "key": "Content-Type", + "value": "application/json" }, { - "key":"X-Requested-With", - "value":"XMLHttpRequest" + "key": "X-Requested-With", + "value": "XMLHttpRequest" } ], - "body":{ - "mode":"raw", - "raw":"{\"user\":{\"email\":\"{{EMAIL}}\", \"password\":\"{{PASSWORD}}\", \"username\":\"{{USERNAME}}\"}}" + "body": { + "mode": "raw", + "raw": "{\"user\":{\"email\":\"{{EMAIL}}\", \"password\":\"{{PASSWORD}}\", \"username\":\"{{USERNAME}}\"}}" }, - "url":{ - "raw":"{{APIURL}}/users", - "host":[ - "{{APIURL}}" - ], - "path":[ - "users" - ] + "url": { + "raw": "{{APIURL}}/users", + "host": ["{{APIURL}}"], + "path": ["users"] } }, - "response":[ - - ] + "response": [] }, { - "name":"Login", - "event":[ + "name": "Login", + "event": [ { - "listen":"test", - "script":{ - "type":"text/javascript", - "exec":[ + "listen": "test", + "script": { + "type": "text/javascript", + "exec": [ "var responseJSON = JSON.parse(responseBody);", "", "tests['Response contains \"user\" property'] = responseJSON.hasOwnProperty('user');", @@ -89,46 +83,39 @@ } } ], - "request":{ - "method":"POST", - "header":[ + "request": { + "method": "POST", + "header": [ { - "key":"Content-Type", - "value":"application/json" + "key": "Content-Type", + "value": "application/json" }, { - "key":"X-Requested-With", - "value":"XMLHttpRequest" + "key": "X-Requested-With", + "value": "XMLHttpRequest" } ], - "body":{ - "mode":"raw", - "raw":"{\"user\":{\"email\":\"{{EMAIL}}\", \"password\":\"{{PASSWORD}}\"}}" + "body": { + "mode": "raw", + "raw": "{\"user\":{\"email\":\"{{EMAIL}}\", \"password\":\"{{PASSWORD}}\"}}" }, - "url":{ - "raw":"{{APIURL}}/users/login", - "host":[ - "{{APIURL}}" - ], - "path":[ - "users", - "login" - ] + "url": { + "raw": "{{APIURL}}/users/login", + "host": ["{{APIURL}}"], + "path": ["users", "login"] } }, - "response":[ - - ] + "response": [] }, { - "name":"Login and Remember Token", - "event":[ + "name": "Login and Remember Token", + "event": [ { - "listen":"test", - "script":{ - "id":"a7674032-bf09-4ae7-8224-4afa2fb1a9f9", - "type":"text/javascript", - "exec":[ + "listen": "test", + "script": { + "id": "a7674032-bf09-4ae7-8224-4afa2fb1a9f9", + "type": "text/javascript", + "exec": [ "var responseJSON = JSON.parse(responseBody);", "", "tests['Response contains \"user\" property'] = responseJSON.hasOwnProperty('user');", @@ -151,45 +138,38 @@ } } ], - "request":{ - "method":"POST", - "header":[ + "request": { + "method": "POST", + "header": [ { - "key":"Content-Type", - "value":"application/json" + "key": "Content-Type", + "value": "application/json" }, { - "key":"X-Requested-With", - "value":"XMLHttpRequest" + "key": "X-Requested-With", + "value": "XMLHttpRequest" } ], - "body":{ - "mode":"raw", - "raw":"{\"user\":{\"email\":\"{{EMAIL}}\", \"password\":\"{{PASSWORD}}\"}}" + "body": { + "mode": "raw", + "raw": "{\"user\":{\"email\":\"{{EMAIL}}\", \"password\":\"{{PASSWORD}}\"}}" }, - "url":{ - "raw":"{{APIURL}}/users/login", - "host":[ - "{{APIURL}}" - ], - "path":[ - "users", - "login" - ] + "url": { + "raw": "{{APIURL}}/users/login", + "host": ["{{APIURL}}"], + "path": ["users", "login"] } }, - "response":[ - - ] + "response": [] }, { - "name":"Current User", - "event":[ + "name": "Current User", + "event": [ { - "listen":"test", - "script":{ - "type":"text/javascript", - "exec":[ + "listen": "test", + "script": { + "type": "text/javascript", + "exec": [ "var responseJSON = JSON.parse(responseBody);", "", "tests['Response contains \"user\" property'] = responseJSON.hasOwnProperty('user');", @@ -206,48 +186,42 @@ } } ], - "request":{ - "method":"GET", - "header":[ + "request": { + "method": "GET", + "header": [ { - "key":"Content-Type", - "value":"application/json" + "key": "Content-Type", + "value": "application/json" }, { - "key":"X-Requested-With", - "value":"XMLHttpRequest" + "key": "X-Requested-With", + "value": "XMLHttpRequest" }, { - "key":"Authorization", - "value":"Token {{token}}" + "key": "Authorization", + "value": "Token {{token}}" } ], - "body":{ - "mode":"raw", - "raw":"" + "body": { + "mode": "raw", + "raw": "" }, - "url":{ - "raw":"{{APIURL}}/user", - "host":[ - "{{APIURL}}" - ], - "path":[ - "user" - ] + "url": { + "raw": "{{APIURL}}/user", + "host": ["{{APIURL}}"], + "path": ["user"] } }, - "response":[ - - ] + "response": [] }, { - "name":"Update User", - "event":[ + "name": "Update User", + "event": [ { - "listen":"test", - "script":{ - "type":"text/javascript", - "exec":[ + "listen": "test", + "script": { + "type": "text/javascript", + "exec": [ "var responseJSON = JSON.parse(responseBody);", "", "tests['Response contains \"user\" property'] = responseJSON.hasOwnProperty('user');", @@ -264,53 +238,47 @@ } } ], - "request":{ - "method":"PUT", - "header":[ + "request": { + "method": "PUT", + "header": [ { - "key":"Content-Type", - "value":"application/json" + "key": "Content-Type", + "value": "application/json" }, { - "key":"X-Requested-With", - "value":"XMLHttpRequest" + "key": "X-Requested-With", + "value": "XMLHttpRequest" }, { - "key":"Authorization", - "value":"Token {{token}}" + "key": "Authorization", + "value": "Token {{token}}" } ], - "body":{ - "mode":"raw", - "raw":"{\"user\":{\"email\":\"{{EMAIL}}\"}}" + "body": { + "mode": "raw", + "raw": "{\"user\":{\"email\":\"{{EMAIL}}\"}}" }, - "url":{ - "raw":"{{APIURL}}/user", - "host":[ - "{{APIURL}}" - ], - "path":[ - "user" - ] + "url": { + "raw": "{{APIURL}}/user", + "host": ["{{APIURL}}"], + "path": ["user"] } }, - "response":[ - - ] + "response": [] } ] }, { - "name":"Articles", - "item":[ + "name": "Articles", + "item": [ { - "name":"All Articles", - "event":[ + "name": "All Articles", + "event": [ { - "listen":"test", - "script":{ - "type":"text/javascript", - "exec":[ + "listen": "test", + "script": { + "type": "text/javascript", + "exec": [ "var is200Response = responseCode.code === 200;", "", "tests['Response code is 200 OK'] = is200Response;", @@ -348,44 +316,38 @@ } } ], - "request":{ - "method":"GET", - "header":[ + "request": { + "method": "GET", + "header": [ { - "key":"Content-Type", - "value":"application/json" + "key": "Content-Type", + "value": "application/json" }, { - "key":"X-Requested-With", - "value":"XMLHttpRequest" + "key": "X-Requested-With", + "value": "XMLHttpRequest" } ], - "body":{ - "mode":"raw", - "raw":"" + "body": { + "mode": "raw", + "raw": "" }, - "url":{ - "raw":"{{APIURL}}/articles", - "host":[ - "{{APIURL}}" - ], - "path":[ - "articles" - ] + "url": { + "raw": "{{APIURL}}/articles", + "host": ["{{APIURL}}"], + "path": ["articles"] } }, - "response":[ - - ] + "response": [] }, { - "name":"Articles by Author", - "event":[ + "name": "Articles by Author", + "event": [ { - "listen":"test", - "script":{ - "type":"text/javascript", - "exec":[ + "listen": "test", + "script": { + "type": "text/javascript", + "exec": [ "var is200Response = responseCode.code === 200;", "", "tests['Response code is 200 OK'] = is200Response;", @@ -423,50 +385,44 @@ } } ], - "request":{ - "method":"GET", - "header":[ + "request": { + "method": "GET", + "header": [ { - "key":"Content-Type", - "value":"application/json" + "key": "Content-Type", + "value": "application/json" }, { - "key":"X-Requested-With", - "value":"XMLHttpRequest" + "key": "X-Requested-With", + "value": "XMLHttpRequest" } ], - "body":{ - "mode":"raw", - "raw":"" + "body": { + "mode": "raw", + "raw": "" }, - "url":{ - "raw":"{{APIURL}}/articles?author=johnjacob", - "host":[ - "{{APIURL}}" - ], - "path":[ - "articles" - ], - "query":[ + "url": { + "raw": "{{APIURL}}/articles?author=johnjacob", + "host": ["{{APIURL}}"], + "path": ["articles"], + "query": [ { - "key":"author", - "value":"johnjacob" + "key": "author", + "value": "johnjacob" } ] } }, - "response":[ - - ] + "response": [] }, { - "name":"Articles Favorited by Username", - "event":[ + "name": "Articles Favorited by Username", + "event": [ { - "listen":"test", - "script":{ - "type":"text/javascript", - "exec":[ + "listen": "test", + "script": { + "type": "text/javascript", + "exec": [ "var is200Response = responseCode.code === 200;", "", "tests['Response code is 200 OK'] = is200Response;", @@ -504,50 +460,44 @@ } } ], - "request":{ - "method":"GET", - "header":[ + "request": { + "method": "GET", + "header": [ { - "key":"Content-Type", - "value":"application/json" + "key": "Content-Type", + "value": "application/json" }, { - "key":"X-Requested-With", - "value":"XMLHttpRequest" + "key": "X-Requested-With", + "value": "XMLHttpRequest" } ], - "body":{ - "mode":"raw", - "raw":"" + "body": { + "mode": "raw", + "raw": "" }, - "url":{ - "raw":"{{APIURL}}/articles?favorited={{USERNAME}}", - "host":[ - "{{APIURL}}" - ], - "path":[ - "articles" - ], - "query":[ + "url": { + "raw": "{{APIURL}}/articles?favorited={{USERNAME}}", + "host": ["{{APIURL}}"], + "path": ["articles"], + "query": [ { - "key":"favorited", - "value":"{{USERNAME}}" + "key": "favorited", + "value": "{{USERNAME}}" } ] } }, - "response":[ - - ] + "response": [] }, { - "name":"Articles by Tag", - "event":[ + "name": "Articles by Tag", + "event": [ { - "listen":"test", - "script":{ - "type":"text/javascript", - "exec":[ + "listen": "test", + "script": { + "type": "text/javascript", + "exec": [ "var is200Response = responseCode.code === 200;", "", "tests['Response code is 200 OK'] = is200Response;", @@ -585,56 +535,50 @@ } } ], - "request":{ - "method":"GET", - "header":[ + "request": { + "method": "GET", + "header": [ { - "key":"Content-Type", - "value":"application/json" + "key": "Content-Type", + "value": "application/json" }, { - "key":"X-Requested-With", - "value":"XMLHttpRequest" + "key": "X-Requested-With", + "value": "XMLHttpRequest" } ], - "body":{ - "mode":"raw", - "raw":"" + "body": { + "mode": "raw", + "raw": "" }, - "url":{ - "raw":"{{APIURL}}/articles?tag=dragons", - "host":[ - "{{APIURL}}" - ], - "path":[ - "articles" - ], - "query":[ + "url": { + "raw": "{{APIURL}}/articles?tag=dragons", + "host": ["{{APIURL}}"], + "path": ["articles"], + "query": [ { - "key":"tag", - "value":"dragons" + "key": "tag", + "value": "dragons" } ] } }, - "response":[ - - ] + "response": [] } ] }, { - "name":"Articles, Favorite, Comments", - "item":[ + "name": "Articles, Favorite, Comments", + "item": [ { - "name":"Create Article", - "event":[ + "name": "Create Article", + "event": [ { - "listen":"test", - "script":{ - "id":"e711dbf8-8065-4ba8-8b74-f1639a7d8208", - "type":"text/javascript", - "exec":[ + "listen": "test", + "script": { + "id": "e711dbf8-8065-4ba8-8b74-f1639a7d8208", + "type": "text/javascript", + "exec": [ "var responseJSON = JSON.parse(responseBody);", "", "tests['Response contains \"article\" property'] = responseJSON.hasOwnProperty('article');", @@ -662,48 +606,42 @@ } } ], - "request":{ - "method":"POST", - "header":[ + "request": { + "method": "POST", + "header": [ { - "key":"Content-Type", - "value":"application/json" + "key": "Content-Type", + "value": "application/json" }, { - "key":"X-Requested-With", - "value":"XMLHttpRequest" + "key": "X-Requested-With", + "value": "XMLHttpRequest" }, { - "key":"Authorization", - "value":"Token {{token}}" + "key": "Authorization", + "value": "Token {{token}}" } ], - "body":{ - "mode":"raw", - "raw":"{\"article\":{\"title\":\"How to train your dragon\", \"description\":\"Ever wonder how?\", \"body\":\"Very carefully.\", \"tagList\":[\"training\", \"dragons\"]}}" + "body": { + "mode": "raw", + "raw": "{\"article\":{\"title\":\"How to train your dragon\", \"description\":\"Ever wonder how?\", \"body\":\"Very carefully.\", \"tagList\":[\"training\", \"dragons\"]}}" }, - "url":{ - "raw":"{{APIURL}}/articles", - "host":[ - "{{APIURL}}" - ], - "path":[ - "articles" - ] + "url": { + "raw": "{{APIURL}}/articles", + "host": ["{{APIURL}}"], + "path": ["articles"] } }, - "response":[ - - ] + "response": [] }, { - "name":"Feed", - "event":[ + "name": "Feed", + "event": [ { - "listen":"test", - "script":{ - "type":"text/javascript", - "exec":[ + "listen": "test", + "script": { + "type": "text/javascript", + "exec": [ "var is200Response = responseCode.code === 200;", "", "tests['Response code is 200 OK'] = is200Response;", @@ -741,49 +679,42 @@ } } ], - "request":{ - "method":"GET", - "header":[ + "request": { + "method": "GET", + "header": [ { - "key":"Content-Type", - "value":"application/json" + "key": "Content-Type", + "value": "application/json" }, { - "key":"X-Requested-With", - "value":"XMLHttpRequest" + "key": "X-Requested-With", + "value": "XMLHttpRequest" }, { - "key":"Authorization", - "value":"Token {{token}}" + "key": "Authorization", + "value": "Token {{token}}" } ], - "body":{ - "mode":"raw", - "raw":"" + "body": { + "mode": "raw", + "raw": "" }, - "url":{ - "raw":"{{APIURL}}/articles/feed", - "host":[ - "{{APIURL}}" - ], - "path":[ - "articles", - "feed" - ] + "url": { + "raw": "{{APIURL}}/articles/feed", + "host": ["{{APIURL}}"], + "path": ["articles", "feed"] } }, - "response":[ - - ] + "response": [] }, { - "name":"All Articles", - "event":[ + "name": "All Articles", + "event": [ { - "listen":"test", - "script":{ - "type":"text/javascript", - "exec":[ + "listen": "test", + "script": { + "type": "text/javascript", + "exec": [ "var is200Response = responseCode.code === 200;", "", "tests['Response code is 200 OK'] = is200Response;", @@ -821,48 +752,42 @@ } } ], - "request":{ - "method":"GET", - "header":[ + "request": { + "method": "GET", + "header": [ { - "key":"Content-Type", - "value":"application/json" + "key": "Content-Type", + "value": "application/json" }, { - "key":"X-Requested-With", - "value":"XMLHttpRequest" + "key": "X-Requested-With", + "value": "XMLHttpRequest" }, { - "key":"Authorization", - "value":"Token {{token}}" + "key": "Authorization", + "value": "Token {{token}}" } ], - "body":{ - "mode":"raw", - "raw":"" + "body": { + "mode": "raw", + "raw": "" }, - "url":{ - "raw":"{{APIURL}}/articles", - "host":[ - "{{APIURL}}" - ], - "path":[ - "articles" - ] + "url": { + "raw": "{{APIURL}}/articles", + "host": ["{{APIURL}}"], + "path": ["articles"] } }, - "response":[ - - ] + "response": [] }, { - "name":"All Articles with auth", - "event":[ + "name": "All Articles with auth", + "event": [ { - "listen":"test", - "script":{ - "type":"text/javascript", - "exec":[ + "listen": "test", + "script": { + "type": "text/javascript", + "exec": [ "var is200Response = responseCode.code === 200;", "", "tests['Response code is 200 OK'] = is200Response;", @@ -900,48 +825,42 @@ } } ], - "request":{ - "method":"GET", - "header":[ + "request": { + "method": "GET", + "header": [ { - "key":"Content-Type", - "value":"application/json" + "key": "Content-Type", + "value": "application/json" }, { - "key":"X-Requested-With", - "value":"XMLHttpRequest" + "key": "X-Requested-With", + "value": "XMLHttpRequest" }, { - "key":"Authorization", - "value":"Token {{token}}" + "key": "Authorization", + "value": "Token {{token}}" } ], - "body":{ - "mode":"raw", - "raw":"" + "body": { + "mode": "raw", + "raw": "" }, - "url":{ - "raw":"{{APIURL}}/articles", - "host":[ - "{{APIURL}}" - ], - "path":[ - "articles" - ] + "url": { + "raw": "{{APIURL}}/articles", + "host": ["{{APIURL}}"], + "path": ["articles"] } }, - "response":[ - - ] + "response": [] }, { - "name":"Articles by Author", - "event":[ + "name": "Articles by Author", + "event": [ { - "listen":"test", - "script":{ - "type":"text/javascript", - "exec":[ + "listen": "test", + "script": { + "type": "text/javascript", + "exec": [ "var is200Response = responseCode.code === 200;", "", "tests['Response code is 200 OK'] = is200Response;", @@ -979,54 +898,48 @@ } } ], - "request":{ - "method":"GET", - "header":[ + "request": { + "method": "GET", + "header": [ { - "key":"Content-Type", - "value":"application/json" + "key": "Content-Type", + "value": "application/json" }, { - "key":"X-Requested-With", - "value":"XMLHttpRequest" + "key": "X-Requested-With", + "value": "XMLHttpRequest" }, { - "key":"Authorization", - "value":"Token {{token}}" + "key": "Authorization", + "value": "Token {{token}}" } ], - "body":{ - "mode":"raw", - "raw":"" + "body": { + "mode": "raw", + "raw": "" }, - "url":{ - "raw":"{{APIURL}}/articles?author={{USERNAME}}", - "host":[ - "{{APIURL}}" - ], - "path":[ - "articles" - ], - "query":[ + "url": { + "raw": "{{APIURL}}/articles?author={{USERNAME}}", + "host": ["{{APIURL}}"], + "path": ["articles"], + "query": [ { - "key":"author", - "value":"{{USERNAME}}" + "key": "author", + "value": "{{USERNAME}}" } ] } }, - "response":[ - - ] + "response": [] }, { - "name":"Articles by Author with auth", - "event":[ + "name": "Articles by Author with auth", + "event": [ { - "listen":"test", - "script":{ - "type":"text/javascript", - "exec":[ + "listen": "test", + "script": { + "type": "text/javascript", + "exec": [ "var is200Response = responseCode.code === 200;", "", "tests['Response code is 200 OK'] = is200Response;", @@ -1064,54 +977,48 @@ } } ], - "request":{ - "method":"GET", - "header":[ + "request": { + "method": "GET", + "header": [ { - "key":"Content-Type", - "value":"application/json" + "key": "Content-Type", + "value": "application/json" }, { - "key":"X-Requested-With", - "value":"XMLHttpRequest" + "key": "X-Requested-With", + "value": "XMLHttpRequest" }, { - "key":"Authorization", - "value":"Token {{token}}" + "key": "Authorization", + "value": "Token {{token}}" } ], - "body":{ - "mode":"raw", - "raw":"" + "body": { + "mode": "raw", + "raw": "" }, - "url":{ - "raw":"{{APIURL}}/articles?author={{USERNAME}}", - "host":[ - "{{APIURL}}" - ], - "path":[ - "articles" - ], - "query":[ + "url": { + "raw": "{{APIURL}}/articles?author={{USERNAME}}", + "host": ["{{APIURL}}"], + "path": ["articles"], + "query": [ { - "key":"author", - "value":"{{USERNAME}}" + "key": "author", + "value": "{{USERNAME}}" } ] } }, - "response":[ - - ] + "response": [] }, { - "name":"Single Article by slug", - "event":[ + "name": "Single Article by slug", + "event": [ { - "listen":"test", - "script":{ - "type":"text/javascript", - "exec":[ + "listen": "test", + "script": { + "type": "text/javascript", + "exec": [ "var responseJSON = JSON.parse(responseBody);", "", "tests['Response contains \"article\" property'] = responseJSON.hasOwnProperty('article');", @@ -1137,49 +1044,42 @@ } } ], - "request":{ - "method":"GET", - "header":[ + "request": { + "method": "GET", + "header": [ { - "key":"Content-Type", - "value":"application/json" + "key": "Content-Type", + "value": "application/json" }, { - "key":"X-Requested-With", - "value":"XMLHttpRequest" + "key": "X-Requested-With", + "value": "XMLHttpRequest" }, { - "key":"Authorization", - "value":"Token {{token}}" + "key": "Authorization", + "value": "Token {{token}}" } ], - "body":{ - "mode":"raw", - "raw":"" + "body": { + "mode": "raw", + "raw": "" }, - "url":{ - "raw":"{{APIURL}}/articles/{{slug}}", - "host":[ - "{{APIURL}}" - ], - "path":[ - "articles", - "{{slug}}" - ] + "url": { + "raw": "{{APIURL}}/articles/{{slug}}", + "host": ["{{APIURL}}"], + "path": ["articles", "{{slug}}"] } }, - "response":[ - - ] + "response": [] }, { - "name":"Articles by Tag", - "event":[ + "name": "Articles by Tag", + "event": [ { - "listen":"test", - "script":{ - "type":"text/javascript", - "exec":[ + "listen": "test", + "script": { + "type": "text/javascript", + "exec": [ "var is200Response = responseCode.code === 200;", "", "tests['Response code is 200 OK'] = is200Response;", @@ -1213,54 +1113,48 @@ } } ], - "request":{ - "method":"GET", - "header":[ + "request": { + "method": "GET", + "header": [ { - "key":"Content-Type", - "value":"application/json" + "key": "Content-Type", + "value": "application/json" }, { - "key":"X-Requested-With", - "value":"XMLHttpRequest" + "key": "X-Requested-With", + "value": "XMLHttpRequest" }, { - "key":"Authorization", - "value":"Token {{token}}" + "key": "Authorization", + "value": "Token {{token}}" } ], - "body":{ - "mode":"raw", - "raw":"" + "body": { + "mode": "raw", + "raw": "" }, - "url":{ - "raw":"{{APIURL}}/articles?tag=dragons", - "host":[ - "{{APIURL}}" - ], - "path":[ - "articles" - ], - "query":[ + "url": { + "raw": "{{APIURL}}/articles?tag=dragons", + "host": ["{{APIURL}}"], + "path": ["articles"], + "query": [ { - "key":"tag", - "value":"dragons" + "key": "tag", + "value": "dragons" } ] } }, - "response":[ - - ] + "response": [] }, { - "name":"Update Article", - "event":[ + "name": "Update Article", + "event": [ { - "listen":"test", - "script":{ - "type":"text/javascript", - "exec":[ + "listen": "test", + "script": { + "type": "text/javascript", + "exec": [ "if (!(environment.isIntegrationTest)) {", "var responseJSON = JSON.parse(responseBody);", "", @@ -1288,49 +1182,42 @@ } } ], - "request":{ - "method":"PUT", - "header":[ + "request": { + "method": "PUT", + "header": [ { - "key":"Content-Type", - "value":"application/json" + "key": "Content-Type", + "value": "application/json" }, { - "key":"X-Requested-With", - "value":"XMLHttpRequest" + "key": "X-Requested-With", + "value": "XMLHttpRequest" }, { - "key":"Authorization", - "value":"Token {{token}}" + "key": "Authorization", + "value": "Token {{token}}" } ], - "body":{ - "mode":"raw", - "raw":"{\"article\":{\"body\":\"With two hands\"}}" + "body": { + "mode": "raw", + "raw": "{\"article\":{\"body\":\"With two hands\"}}" }, - "url":{ - "raw":"{{APIURL}}/articles/{{slug}}", - "host":[ - "{{APIURL}}" - ], - "path":[ - "articles", - "{{slug}}" - ] + "url": { + "raw": "{{APIURL}}/articles/{{slug}}", + "host": ["{{APIURL}}"], + "path": ["articles", "{{slug}}"] } }, - "response":[ - - ] + "response": [] }, { - "name":"Favorite Article", - "event":[ + "name": "Favorite Article", + "event": [ { - "listen":"test", - "script":{ - "type":"text/javascript", - "exec":[ + "listen": "test", + "script": { + "type": "text/javascript", + "exec": [ "var responseJSON = JSON.parse(responseBody);", "", "tests['Response contains \"article\" property'] = responseJSON.hasOwnProperty('article');", @@ -1358,50 +1245,42 @@ } } ], - "request":{ - "method":"POST", - "header":[ + "request": { + "method": "POST", + "header": [ { - "key":"Content-Type", - "value":"application/json" + "key": "Content-Type", + "value": "application/json" }, { - "key":"X-Requested-With", - "value":"XMLHttpRequest" + "key": "X-Requested-With", + "value": "XMLHttpRequest" }, { - "key":"Authorization", - "value":"Token {{token}}" + "key": "Authorization", + "value": "Token {{token}}" } ], - "body":{ - "mode":"raw", - "raw":"" + "body": { + "mode": "raw", + "raw": "" }, - "url":{ - "raw":"{{APIURL}}/articles/{{slug}}/favorite", - "host":[ - "{{APIURL}}" - ], - "path":[ - "articles", - "{{slug}}", - "favorite" - ] + "url": { + "raw": "{{APIURL}}/articles/{{slug}}/favorite", + "host": ["{{APIURL}}"], + "path": ["articles", "{{slug}}", "favorite"] } }, - "response":[ - - ] + "response": [] }, { - "name":"Articles Favorited by Username", - "event":[ + "name": "Articles Favorited by Username", + "event": [ { - "listen":"test", - "script":{ - "type":"text/javascript", - "exec":[ + "listen": "test", + "script": { + "type": "text/javascript", + "exec": [ "var is200Response = responseCode.code === 200;", "", "tests['Response code is 200 OK'] = is200Response;", @@ -1432,54 +1311,48 @@ } } ], - "request":{ - "method":"GET", - "header":[ + "request": { + "method": "GET", + "header": [ { - "key":"Content-Type", - "value":"application/json" + "key": "Content-Type", + "value": "application/json" }, { - "key":"X-Requested-With", - "value":"XMLHttpRequest" + "key": "X-Requested-With", + "value": "XMLHttpRequest" }, { - "key":"Authorization", - "value":"Token {{token}}" + "key": "Authorization", + "value": "Token {{token}}" } ], - "body":{ - "mode":"raw", - "raw":"" + "body": { + "mode": "raw", + "raw": "" }, - "url":{ - "raw":"{{APIURL}}/articles?favorited={{USERNAME}}", - "host":[ - "{{APIURL}}" - ], - "path":[ - "articles" - ], - "query":[ + "url": { + "raw": "{{APIURL}}/articles?favorited={{USERNAME}}", + "host": ["{{APIURL}}"], + "path": ["articles"], + "query": [ { - "key":"favorited", - "value":"{{USERNAME}}" + "key": "favorited", + "value": "{{USERNAME}}" } ] } }, - "response":[ - - ] + "response": [] }, { - "name":"Articles Favorited by Username with auth", - "event":[ + "name": "Articles Favorited by Username with auth", + "event": [ { - "listen":"test", - "script":{ - "type":"text/javascript", - "exec":[ + "listen": "test", + "script": { + "type": "text/javascript", + "exec": [ "var is200Response = responseCode.code === 200;", "", "tests['Response code is 200 OK'] = is200Response;", @@ -1510,54 +1383,48 @@ } } ], - "request":{ - "method":"GET", - "header":[ + "request": { + "method": "GET", + "header": [ { - "key":"Content-Type", - "value":"application/json" + "key": "Content-Type", + "value": "application/json" }, { - "key":"X-Requested-With", - "value":"XMLHttpRequest" + "key": "X-Requested-With", + "value": "XMLHttpRequest" }, { - "key":"Authorization", - "value":"Token {{token}}" + "key": "Authorization", + "value": "Token {{token}}" } ], - "body":{ - "mode":"raw", - "raw":"" + "body": { + "mode": "raw", + "raw": "" }, - "url":{ - "raw":"{{APIURL}}/articles?favorited={{USERNAME}}", - "host":[ - "{{APIURL}}" - ], - "path":[ - "articles" - ], - "query":[ + "url": { + "raw": "{{APIURL}}/articles?favorited={{USERNAME}}", + "host": ["{{APIURL}}"], + "path": ["articles"], + "query": [ { - "key":"favorited", - "value":"{{USERNAME}}" + "key": "favorited", + "value": "{{USERNAME}}" } ] } }, - "response":[ - - ] + "response": [] }, { - "name":"Unfavorite Article", - "event":[ + "name": "Unfavorite Article", + "event": [ { - "listen":"test", - "script":{ - "type":"text/javascript", - "exec":[ + "listen": "test", + "script": { + "type": "text/javascript", + "exec": [ "var responseJSON = JSON.parse(responseBody);", "", "tests['Response contains \"article\" property'] = responseJSON.hasOwnProperty('article');", @@ -1584,51 +1451,43 @@ } } ], - "request":{ - "method":"DELETE", - "header":[ + "request": { + "method": "DELETE", + "header": [ { - "key":"Content-Type", - "value":"application/json" + "key": "Content-Type", + "value": "application/json" }, { - "key":"X-Requested-With", - "value":"XMLHttpRequest" + "key": "X-Requested-With", + "value": "XMLHttpRequest" }, { - "key":"Authorization", - "value":"Token {{token}}" + "key": "Authorization", + "value": "Token {{token}}" } ], - "body":{ - "mode":"raw", - "raw":"" + "body": { + "mode": "raw", + "raw": "" }, - "url":{ - "raw":"{{APIURL}}/articles/{{slug}}/favorite", - "host":[ - "{{APIURL}}" - ], - "path":[ - "articles", - "{{slug}}", - "favorite" - ] + "url": { + "raw": "{{APIURL}}/articles/{{slug}}/favorite", + "host": ["{{APIURL}}"], + "path": ["articles", "{{slug}}", "favorite"] } }, - "response":[ - - ] + "response": [] }, { - "name":"Create Comment for Article", - "event":[ + "name": "Create Comment for Article", + "event": [ { - "listen":"test", - "script":{ - "id":"9f90c364-cc68-4728-961a-85eb00197d7b", - "type":"text/javascript", - "exec":[ + "listen": "test", + "script": { + "id": "9f90c364-cc68-4728-961a-85eb00197d7b", + "type": "text/javascript", + "exec": [ "var responseJSON = JSON.parse(responseBody);", "", "tests['Response contains \"comment\" property'] = responseJSON.hasOwnProperty('comment');", @@ -1649,50 +1508,42 @@ } } ], - "request":{ - "method":"POST", - "header":[ + "request": { + "method": "POST", + "header": [ { - "key":"Content-Type", - "value":"application/json" + "key": "Content-Type", + "value": "application/json" }, { - "key":"X-Requested-With", - "value":"XMLHttpRequest" + "key": "X-Requested-With", + "value": "XMLHttpRequest" }, { - "key":"Authorization", - "value":"Token {{token}}" + "key": "Authorization", + "value": "Token {{token}}" } ], - "body":{ - "mode":"raw", - "raw":"{\"comment\":{\"body\":\"Thank you so much!\"}}" + "body": { + "mode": "raw", + "raw": "{\"comment\":{\"body\":\"Thank you so much!\"}}" }, - "url":{ - "raw":"{{APIURL}}/articles/{{slug}}/comments", - "host":[ - "{{APIURL}}" - ], - "path":[ - "articles", - "{{slug}}", - "comments" - ] + "url": { + "raw": "{{APIURL}}/articles/{{slug}}/comments", + "host": ["{{APIURL}}"], + "path": ["articles", "{{slug}}", "comments"] } }, - "response":[ - - ] + "response": [] }, { - "name":"All Comments for Article", - "event":[ + "name": "All Comments for Article", + "event": [ { - "listen":"test", - "script":{ - "type":"text/javascript", - "exec":[ + "listen": "test", + "script": { + "type": "text/javascript", + "exec": [ "var is200Response = responseCode.code === 200", "", "tests['Response code is 200 OK'] = is200Response;", @@ -1719,50 +1570,42 @@ } } ], - "request":{ - "method":"GET", - "header":[ + "request": { + "method": "GET", + "header": [ { - "key":"Content-Type", - "value":"application/json" + "key": "Content-Type", + "value": "application/json" }, { - "key":"X-Requested-With", - "value":"XMLHttpRequest" + "key": "X-Requested-With", + "value": "XMLHttpRequest" }, { - "key":"Authorization", - "value":"Token {{token}}" + "key": "Authorization", + "value": "Token {{token}}" } ], - "body":{ - "mode":"raw", - "raw":"" + "body": { + "mode": "raw", + "raw": "" }, - "url":{ - "raw":"{{APIURL}}/articles/{{slug}}/comments", - "host":[ - "{{APIURL}}" - ], - "path":[ - "articles", - "{{slug}}", - "comments" - ] + "url": { + "raw": "{{APIURL}}/articles/{{slug}}/comments", + "host": ["{{APIURL}}"], + "path": ["articles", "{{slug}}", "comments"] } }, - "response":[ - - ] + "response": [] }, { - "name":"All Comments for Article without login", - "event":[ + "name": "All Comments for Article without login", + "event": [ { - "listen":"test", - "script":{ - "type":"text/javascript", - "exec":[ + "listen": "test", + "script": { + "type": "text/javascript", + "exec": [ "var is200Response = responseCode.code === 200", "", "tests['Response code is 200 OK'] = is200Response;", @@ -1789,149 +1632,121 @@ } } ], - "request":{ - "method":"GET", - "header":[ + "request": { + "method": "GET", + "header": [ { - "key":"Content-Type", - "value":"application/json" + "key": "Content-Type", + "value": "application/json" }, { - "key":"X-Requested-With", - "value":"XMLHttpRequest" + "key": "X-Requested-With", + "value": "XMLHttpRequest" } ], - "body":{ - "mode":"raw", - "raw":"" + "body": { + "mode": "raw", + "raw": "" }, - "url":{ - "raw":"{{APIURL}}/articles/{{slug}}/comments", - "host":[ - "{{APIURL}}" - ], - "path":[ - "articles", - "{{slug}}", - "comments" - ] + "url": { + "raw": "{{APIURL}}/articles/{{slug}}/comments", + "host": ["{{APIURL}}"], + "path": ["articles", "{{slug}}", "comments"] } }, - "response":[ - - ] + "response": [] }, { - "name":"Delete Comment for Article", - "request":{ - "method":"DELETE", - "header":[ + "name": "Delete Comment for Article", + "request": { + "method": "DELETE", + "header": [ { - "key":"Content-Type", - "value":"application/json" + "key": "Content-Type", + "value": "application/json" }, { - "key":"X-Requested-With", - "value":"XMLHttpRequest" + "key": "X-Requested-With", + "value": "XMLHttpRequest" }, { - "key":"Authorization", - "value":"Token {{token}}" + "key": "Authorization", + "value": "Token {{token}}" } ], - "body":{ - "mode":"raw", - "raw":"" + "body": { + "mode": "raw", + "raw": "" }, - "url":{ - "raw":"{{APIURL}}/articles/{{slug}}/comments/{{commentId}}", - "host":[ - "{{APIURL}}" - ], - "path":[ - "articles", - "{{slug}}", - "comments", - "{{commentId}}" - ] + "url": { + "raw": "{{APIURL}}/articles/{{slug}}/comments/{{commentId}}", + "host": ["{{APIURL}}"], + "path": ["articles", "{{slug}}", "comments", "{{commentId}}"] } }, - "response":[ - - ] + "response": [] }, { - "name":"Delete Article", - "request":{ - "method":"DELETE", - "header":[ + "name": "Delete Article", + "request": { + "method": "DELETE", + "header": [ { - "key":"Content-Type", - "value":"application/json" + "key": "Content-Type", + "value": "application/json" }, { - "key":"X-Requested-With", - "value":"XMLHttpRequest" + "key": "X-Requested-With", + "value": "XMLHttpRequest" }, { - "key":"Authorization", - "value":"Token {{token}}" + "key": "Authorization", + "value": "Token {{token}}" } ], - "body":{ - "mode":"raw", - "raw":"" + "body": { + "mode": "raw", + "raw": "" }, - "url":{ - "raw":"{{APIURL}}/articles/{{slug}}", - "host":[ - "{{APIURL}}" - ], - "path":[ - "articles", - "{{slug}}" - ] + "url": { + "raw": "{{APIURL}}/articles/{{slug}}", + "host": ["{{APIURL}}"], + "path": ["articles", "{{slug}}"] } }, - "response":[ - - ] + "response": [] } ], - "event":[ + "event": [ { - "listen":"prerequest", - "script":{ - "id":"67853a4a-e972-4573-a295-dad12a46a9d7", - "type":"text/javascript", - "exec":[ - "" - ] + "listen": "prerequest", + "script": { + "id": "67853a4a-e972-4573-a295-dad12a46a9d7", + "type": "text/javascript", + "exec": [""] } }, { - "listen":"test", - "script":{ - "id":"3057f989-15e4-484e-b8fa-a041043d0ac0", - "type":"text/javascript", - "exec":[ - "" - ] + "listen": "test", + "script": { + "id": "3057f989-15e4-484e-b8fa-a041043d0ac0", + "type": "text/javascript", + "exec": [""] } } ] }, { - "name":"Profiles", - "item":[ + "name": "Profiles", + "item": [ { - "name":"Register Celeb", - "event":[ + "name": "Register Celeb", + "event": [ { - "listen":"test", - "script":{ - "type":"text/javascript", - "exec":[ + "listen": "test", + "script": { + "type": "text/javascript", + "exec": [ "if (!(environment.isIntegrationTest)) {", "var responseJSON = JSON.parse(responseBody);", "", @@ -1950,44 +1765,38 @@ } } ], - "request":{ - "method":"POST", - "header":[ + "request": { + "method": "POST", + "header": [ { - "key":"Content-Type", - "value":"application/json" + "key": "Content-Type", + "value": "application/json" }, { - "key":"X-Requested-With", - "value":"XMLHttpRequest" + "key": "X-Requested-With", + "value": "XMLHttpRequest" } ], - "body":{ - "mode":"raw", - "raw":"{\"user\":{\"email\":\"celeb_{{EMAIL}}\", \"password\":\"{{PASSWORD}}\", \"username\":\"celeb_{{USERNAME}}\"}}" + "body": { + "mode": "raw", + "raw": "{\"user\":{\"email\":\"celeb_{{EMAIL}}\", \"password\":\"{{PASSWORD}}\", \"username\":\"celeb_{{USERNAME}}\"}}" }, - "url":{ - "raw":"{{APIURL}}/users", - "host":[ - "{{APIURL}}" - ], - "path":[ - "users" - ] + "url": { + "raw": "{{APIURL}}/users", + "host": ["{{APIURL}}"], + "path": ["users"] } }, - "response":[ - - ] + "response": [] }, { - "name":"Profile", - "event":[ + "name": "Profile", + "event": [ { - "listen":"test", - "script":{ - "type":"text/javascript", - "exec":[ + "listen": "test", + "script": { + "type": "text/javascript", + "exec": [ "if (!(environment.isIntegrationTest)) {", "var is200Response = responseCode.code === 200;", "", @@ -2011,49 +1820,42 @@ } } ], - "request":{ - "method":"GET", - "header":[ + "request": { + "method": "GET", + "header": [ { - "key":"Content-Type", - "value":"application/json" + "key": "Content-Type", + "value": "application/json" }, { - "key":"X-Requested-With", - "value":"XMLHttpRequest" + "key": "X-Requested-With", + "value": "XMLHttpRequest" }, { - "key":"Authorization", - "value":"Token {{token}}" + "key": "Authorization", + "value": "Token {{token}}" } ], - "body":{ - "mode":"raw", - "raw":"" + "body": { + "mode": "raw", + "raw": "" }, - "url":{ - "raw":"{{APIURL}}/profiles/celeb_{{USERNAME}}", - "host":[ - "{{APIURL}}" - ], - "path":[ - "profiles", - "celeb_{{USERNAME}}" - ] + "url": { + "raw": "{{APIURL}}/profiles/celeb_{{USERNAME}}", + "host": ["{{APIURL}}"], + "path": ["profiles", "celeb_{{USERNAME}}"] } }, - "response":[ - - ] + "response": [] }, { - "name":"Follow Profile", - "event":[ + "name": "Follow Profile", + "event": [ { - "listen":"test", - "script":{ - "type":"text/javascript", - "exec":[ + "listen": "test", + "script": { + "type": "text/javascript", + "exec": [ "if (!(environment.isIntegrationTest)) {", "var is200Response = responseCode.code === 200;", "", @@ -2078,50 +1880,42 @@ } } ], - "request":{ - "method":"POST", - "header":[ + "request": { + "method": "POST", + "header": [ { - "key":"Content-Type", - "value":"application/json" + "key": "Content-Type", + "value": "application/json" }, { - "key":"X-Requested-With", - "value":"XMLHttpRequest" + "key": "X-Requested-With", + "value": "XMLHttpRequest" }, { - "key":"Authorization", - "value":"Token {{token}}" + "key": "Authorization", + "value": "Token {{token}}" } ], - "body":{ - "mode":"raw", - "raw":"{\"user\":{\"email\":\"{{EMAIL}}\"}}" + "body": { + "mode": "raw", + "raw": "{\"user\":{\"email\":\"{{EMAIL}}\"}}" }, - "url":{ - "raw":"{{APIURL}}/profiles/celeb_{{USERNAME}}/follow", - "host":[ - "{{APIURL}}" - ], - "path":[ - "profiles", - "celeb_{{USERNAME}}", - "follow" - ] + "url": { + "raw": "{{APIURL}}/profiles/celeb_{{USERNAME}}/follow", + "host": ["{{APIURL}}"], + "path": ["profiles", "celeb_{{USERNAME}}", "follow"] } }, - "response":[ - - ] + "response": [] }, { - "name":"Unfollow Profile", - "event":[ + "name": "Unfollow Profile", + "event": [ { - "listen":"test", - "script":{ - "type":"text/javascript", - "exec":[ + "listen": "test", + "script": { + "type": "text/javascript", + "exec": [ "if (!(environment.isIntegrationTest)) {", "var is200Response = responseCode.code === 200;", "", @@ -2146,55 +1940,47 @@ } } ], - "request":{ - "method":"DELETE", - "header":[ + "request": { + "method": "DELETE", + "header": [ { - "key":"Content-Type", - "value":"application/json" + "key": "Content-Type", + "value": "application/json" }, { - "key":"X-Requested-With", - "value":"XMLHttpRequest" + "key": "X-Requested-With", + "value": "XMLHttpRequest" }, { - "key":"Authorization", - "value":"Token {{token}}" + "key": "Authorization", + "value": "Token {{token}}" } ], - "body":{ - "mode":"raw", - "raw":"" + "body": { + "mode": "raw", + "raw": "" }, - "url":{ - "raw":"{{APIURL}}/profiles/celeb_{{USERNAME}}/follow", - "host":[ - "{{APIURL}}" - ], - "path":[ - "profiles", - "celeb_{{USERNAME}}", - "follow" - ] + "url": { + "raw": "{{APIURL}}/profiles/celeb_{{USERNAME}}/follow", + "host": ["{{APIURL}}"], + "path": ["profiles", "celeb_{{USERNAME}}", "follow"] } }, - "response":[ - - ] + "response": [] } ] }, { - "name":"Tags", - "item":[ + "name": "Tags", + "item": [ { - "name":"All Tags", - "event":[ + "name": "All Tags", + "event": [ { - "listen":"test", - "script":{ - "type":"text/javascript", - "exec":[ + "listen": "test", + "script": { + "type": "text/javascript", + "exec": [ "var is200Response = responseCode.code === 200;", "", "tests['Response code is 200 OK'] = is200Response;", @@ -2210,35 +1996,29 @@ } } ], - "request":{ - "method":"GET", - "header":[ + "request": { + "method": "GET", + "header": [ { - "key":"Content-Type", - "value":"application/json" + "key": "Content-Type", + "value": "application/json" }, { - "key":"X-Requested-With", - "value":"XMLHttpRequest" + "key": "X-Requested-With", + "value": "XMLHttpRequest" } ], - "body":{ - "mode":"raw", - "raw":"" + "body": { + "mode": "raw", + "raw": "" }, - "url":{ - "raw":"{{APIURL}}/tags", - "host":[ - "{{APIURL}}" - ], - "path":[ - "tags" - ] + "url": { + "raw": "{{APIURL}}/tags", + "host": ["{{APIURL}}"], + "path": ["tags"] } }, - "response":[ - - ] + "response": [] } ] } diff --git a/apps/api/.eslintrc.json b/apps/api/.eslintrc.json new file mode 100644 index 000000000..9d9c0db55 --- /dev/null +++ b/apps/api/.eslintrc.json @@ -0,0 +1,18 @@ +{ + "extends": ["../../.eslintrc.json"], + "ignorePatterns": ["!**/*"], + "overrides": [ + { + "files": ["*.ts", "*.tsx", "*.js", "*.jsx"], + "rules": {} + }, + { + "files": ["*.ts", "*.tsx"], + "rules": {} + }, + { + "files": ["*.js", "*.jsx"], + "rules": {} + } + ] +} diff --git a/apps/api/jest.config.ts b/apps/api/jest.config.ts new file mode 100644 index 000000000..619cb7abd --- /dev/null +++ b/apps/api/jest.config.ts @@ -0,0 +1,18 @@ +/* eslint-disable */ +export default { + clearMocks: true, + displayName: 'api', + preset: '../../jest.preset.js', + globals: { + 'ts-jest': { + tsconfig: '
- This is the generated root route.{' '}
- Click here for page 2.
+ This is the generated root route. Click here for page 2.
}
/>
diff --git a/apps/demo/src/app/nx-welcome.tsx b/apps/demo/src/app/nx-welcome.tsx
index 3c1a440fe..a1322bd24 100644
--- a/apps/demo/src/app/nx-welcome.tsx
+++ b/apps/demo/src/app/nx-welcome.tsx
@@ -665,11 +665,7 @@ export function NxWelcome({ title }: { title: string }) {
-
- - You can activate distributed tasks executions and caching by - running: -
+You can activate distributed tasks executions and caching by running:
nx connect-to-nx-cloud- + {' '} What is Nx Cloud?{' '} diff --git a/apps/demo/src/main.tsx b/apps/demo/src/main.tsx index 563fabfe0..eaffab661 100644 --- a/apps/demo/src/main.tsx +++ b/apps/demo/src/main.tsx @@ -4,13 +4,11 @@ import { BrowserRouter } from 'react-router-dom'; import App from './app/app'; -const root = ReactDOM.createRoot( - document.getElementById('root') as HTMLElement -); +const root = ReactDOM.createRoot(document.getElementById('root') as HTMLElement); root.render(
})
+
+
+
-> See how *the exact same* Medium.com clone (called [Conduit](https://demo.realworld.io)) is built using different [frontends](https://codebase.show/projects/realworld?category=frontend) and [backends](https://codebase.show/projects/realworld?category=backend). Yes, you can mix and match them, because **they all adhere to the same [API spec](specs/backend-specs/introduction)** ๐ฎ๐
+> See how _the exact same_ Medium.com clone (called [Conduit](https://demo.realworld.io)) is built using different [frontends](https://codebase.show/projects/realworld?category=frontend) and [backends](https://codebase.show/projects/realworld?category=backend). Yes, you can mix and match them, because **they all adhere to the same [API spec](specs/backend-specs/introduction)** ๐ฎ๐
While most "todo" demos provide an excellent cursory glance at a framework's capabilities, they typically don't convey the knowledge & perspective required to actually build _real_ applications with it.
**RealWorld** solves this by allowing you to choose any frontend (React, Angular, & more) and any backend (Node, Django, & more) and see how they power a real world, beautifully designed fullstack app called [**Conduit**](https://demo.realworld.io).
-*Read the [full blog post announcing RealWorld on Medium.](https://medium.com/@ericsimons/introducing-realworld-6016654d36b5)*
+_Read the [full blog post announcing RealWorld on Medium.](https://medium.com/@ericsimons/introducing-realworld-6016654d36b5)_
Join us on [GitHub Discussions!](https://github.com/gothinkster/realworld/discussions) ๐
diff --git a/apps/documentation/docs/specs/backend-specs/endpoints.md b/apps/documentation/docs/specs/backend-specs/endpoints.md
index 718750641..d3fd88758 100644
--- a/apps/documentation/docs/specs/backend-specs/endpoints.md
+++ b/apps/documentation/docs/specs/backend-specs/endpoints.md
@@ -10,12 +10,12 @@ You can read the authentication header from the headers of the request
`Authorization: Token jwt.token.here`
-
### Authentication:
`POST /api/users/login`
Example request body:
+
```JSON
{
"user":{
@@ -29,12 +29,12 @@ No authentication required, returns a [User](/specs/backend-specs/api-response-f
Required fields: `email`, `password`
-
### Registration:
`POST /api/users`
Example request body:
+
```JSON
{
"user":{
@@ -49,21 +49,18 @@ No authentication required, returns a [User](/specs/backend-specs/api-response-f
Required fields: `email`, `username`, `password`
-
-
### Get Current User
`GET /api/user`
Authentication required, returns a [User](/specs/backend-specs/api-response-format.md#users-for-authentication) that's the current user
-
-
### Update User
`PUT /api/user`
Example request body:
+
```JSON
{
"user":{
@@ -76,19 +73,14 @@ Example request body:
Authentication required, returns the [User](/specs/backend-specs/api-response-format.md#users-for-authentication)
-
Accepted fields: `email`, `username`, `password`, `image`, `bio`
-
-
### Get Profile
`GET /api/profiles/:username`
Authentication optional, returns a [Profile](/specs/backend-specs/api-response-format.md#profile)
-
-
### Follow user
`POST /api/profiles/:username/follow`
@@ -97,8 +89,6 @@ Authentication required, returns a [Profile](/specs/backend-specs/api-response-f
No additional parameters required
-
-
### Unfollow user
`DELETE /api/profiles/:username/follow`
@@ -107,8 +97,6 @@ Authentication required, returns a [Profile](/specs/backend-specs/api-response-f
No additional parameters required
-
-
### List Articles
`GET /api/articles`
@@ -139,8 +127,6 @@ Offset/skip number of articles (default is 0):
Authentication optional, will return [multiple articles](/specs/backend-specs/api-response-format.md#multiple-articles), ordered by most recent first
-
-
### Feed Articles
`GET /api/articles/feed`
@@ -149,7 +135,6 @@ Can also take `limit` and `offset` query parameters like [List Articles](/specs/
Authentication required, will return [multiple articles](/specs/backend-specs/api-response-format.md#multiple-articles) created by followed users, ordered by most recent first.
-
### Get Article
`GET /api/articles/:slug`
@@ -179,8 +164,6 @@ Required fields: `title`, `description`, `body`
Optional fields: `tagList` as an array of Strings
-
-
### Update Article
`PUT /api/articles/:slug`
@@ -201,15 +184,12 @@ Optional fields: `title`, `description`, `body`
The `slug` also gets updated when the `title` is changed
-
### Delete Article
`DELETE /api/articles/:slug`
Authentication required
-
-
### Add Comments to an Article
`POST /api/articles/:slug/comments`
@@ -228,24 +208,18 @@ Authentication required, returns the created [Comment](/specs/backend-specs/api-
Required field: `body`
-
-
### Get Comments from an Article
`GET /api/articles/:slug/comments`
Authentication optional, returns [multiple comments](/specs/backend-specs/api-response-format.md#multiple-comments)
-
-
### Delete Comment
`DELETE /api/articles/:slug/comments/:id`
Authentication required
-
-
### Favorite Article
`POST /api/articles/:slug/favorite`
@@ -254,8 +228,6 @@ Authentication required, returns the [Article](/specs/backend-specs/api-response
No additional parameters required
-
-
### Unfavorite Article
`DELETE /api/articles/:slug/favorite`
@@ -264,8 +236,6 @@ Authentication required, returns the [Article](/specs/backend-specs/api-response
No additional parameters required
-
-
### Get Tags
`GET /api/tags`
diff --git a/apps/documentation/docs/specs/backend-specs/introduction.md b/apps/documentation/docs/specs/backend-specs/introduction.md
index 217c57407..6b75d854f 100644
--- a/apps/documentation/docs/specs/backend-specs/introduction.md
+++ b/apps/documentation/docs/specs/backend-specs/introduction.md
@@ -4,7 +4,6 @@ sidebar_position: 1
# Introduction
-
All backend implementations need to adhere to our [API spec](https://github.com/gothinkster/realworld/tree/main/api).
For your convenience, we have a [Postman collection](https://github.com/gothinkster/realworld/blob/main/api/Conduit.postman_collection.json) that you can use to test your API endpoints as you build your app.
diff --git a/apps/documentation/docs/specs/backend-specs/postman.md b/apps/documentation/docs/specs/backend-specs/postman.md
index ee7d16e35..0b9484062 100644
--- a/apps/documentation/docs/specs/backend-specs/postman.md
+++ b/apps/documentation/docs/specs/backend-specs/postman.md
@@ -6,8 +6,6 @@ sidebar_position: 6
For your convenience, we have a [Postman collection](https://github.com/gothinkster/realworld/blob/master/api/Conduit.postman_collection.json) that you can use to test your API endpoints as you build your app.
-
## Running API tests locally
To locally run the provided Postman collection against your backend, follow instructions [here](https://github.com/gothinkster/realworld/tree/main/api).
-
diff --git a/apps/documentation/docs/specs/frontend-specs/api.md b/apps/documentation/docs/specs/frontend-specs/api.md
index f01b8f888..1148cc062 100644
--- a/apps/documentation/docs/specs/frontend-specs/api.md
+++ b/apps/documentation/docs/specs/frontend-specs/api.md
@@ -5,6 +5,7 @@ sidebar_position: 5
# API
This project provides you different solutions to test your frontend implementation with an API by:
+
- [running our official backend implementation locally](#run-the-official-backend-implementation-locally)
- [hosting your own API](#host-your-own-api)
- [using the API deployed for the official demo](#demo-api)
@@ -19,14 +20,14 @@ The Readme will provide you guidances to start the server locally.
We encourage you to use this implementation's **main** branch for local tests as the **limited** one includes [limitations](#api-limitations) aimed to protect public-hosted APIs.
:::
-
## Host your own API
The official backend implementation includes a [**Deploy to Heroku** button](https://github.com/gothinkster/node-express-prisma-v1-official-app#deploy-to-heroku).
This button provides you a quick and easy way to deploy the API on Heroku for your frontend implementation.
-:::caution
+:::caution
The official backend implementation repository includes two branches:
+
- the **main** branch which adheres to the RealWorld backend specs
- the **limited** branch which includes limitations for public-hosted APIs
@@ -39,7 +40,6 @@ The **limited** branch will be more suitable if you plan to host your implementa
This project provides you with a public hosted API to test your frontend implementations.
Point your API requests to `https://api.realworld.io/api` and you're good to go!
-
### API Usage
The usage of the API is free and non-limited by any kind of key.
@@ -60,17 +60,17 @@ Most of the requests require a valid token.
You can retrieve a token by logging in or by registering.
Log in : https://api.realworld.io/api-docs/#/User%20and%20Authentication/Login
-Register: https://api.realworld.io/api-docs/#/User%20and%20Authentication/CreateUser
+Register: https://api.realworld.io/api-docs/#/User%20and%20Authentication/CreateUser
-* Click the `Try it out` button
-* populate the body input with the related credentials
-* Click `Execute` button
-* Copy the token from the response body
+- Click the `Try it out` button
+- populate the body input with the related credentials
+- Click `Execute` button
+- Copy the token from the response body
#### Register the token
-* Click `Authorize` button on top of the Swagger documentation page
-* Populate the field with `Token