4 | 
5 |
9 |
10 |
11 | > See how _the exact same_ Medium.com clone 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)** 😮😎
12 |
13 | 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.
14 |
15 | **RealWorld** solves this by allowing you to choose any frontend (React, Angular, & more) and any backend (Node, Django, & more).
16 |
17 | _Read the [full blog post announcing RealWorld on Medium.](https://medium.com/@ericsimons/introducing-realworld-6016654d36b5)_
18 |
19 | Join us on [GitHub Discussions!](https://github.com/gothinkster/realworld/discussions) 🎉
20 |
21 | ## Implementations
22 |
23 | Over 150 implementations have been created using various languages, libraries, and frameworks.
24 |
25 | Explore them on [**CodebaseShow**](https://codebase.show/projects/realworld).
26 |
27 | ## Create a new implementation
28 |
29 | [**Create a new implementation >>>**](implementation-creation/introduction)
30 |
31 | Or you can [view upcoming implementations (WIPs)](https://github.com/gothinkster/realworld/discussions/categories/wip-implementations).
32 |
33 | ## Learn more
34 |
35 | - ["Introducing RealWorld 🙌"](https://medium.com/@ericsimons/introducing-realworld-6016654d36b5) by Eric Simons
36 | - Every tutorial is built against the same [API spec](/specifications/backend/introduction) to ensure modularity of every frontend & backend
37 | - Every frontend utilizes the same hand crafted [Bootstrap 4 theme](https://github.com/gothinkster/conduit-bootstrap-template) for identical UI/UX
38 | - There is a [hosted version](https://realworld-docs.netlify.app/docs/specs/frontend-specs/api#demo-api) of the backend API available for public usage, no API keys are required
39 | - Interested in creating a new RealWorld stack? View our [starter guide & spec](implementation-creation/introduction)
40 |
--------------------------------------------------------------------------------
/apps/api/server/routes/api/users/index.post.ts:
--------------------------------------------------------------------------------
1 | import HttpException from "~/models/http-exception.model";
2 | import {default as bcrypt} from 'bcryptjs';
3 |
4 | export default defineEventHandler(async (event) => {
5 | const {user} = await readBody(event);
6 |
7 | const email = user.email?.trim();
8 | const username = user.username?.trim();
9 | const password = user.password?.trim();
10 | const {image, bio, demo} = user;
11 |
12 | if (!email) {
13 | throw new HttpException(422, {errors: {email: ["can't be blank"]}});
14 | }
15 |
16 | if (!username) {
17 | throw new HttpException(422, {errors: {username: ["can't be blank"]}});
18 | }
19 |
20 | if (!password) {
21 | throw new HttpException(422, {errors: {password: ["can't be blank"]}});
22 | }
23 |
24 | await checkUserUniqueness(email, username);
25 |
26 | const hashedPassword = await bcrypt.hash(password, 10);
27 |
28 | const createdUser = await usePrisma().user.create({
29 | data: {
30 | username,
31 | email,
32 | password: hashedPassword,
33 | ...(image ? {image} : {}),
34 | ...(bio ? {bio} : {}),
35 | ...(demo ? {demo} : {}),
36 | },
37 | select: {
38 | id: true,
39 | email: true,
40 | username: true,
41 | bio: true,
42 | image: true,
43 | },
44 | });
45 |
46 | return {
47 | user: {
48 | ...createdUser,
49 | token: useGenerateToken(createdUser.id),
50 | }
51 | };
52 | });
53 |
54 | const checkUserUniqueness = async (email: string, username: string) => {
55 | const existingUserByEmail = await usePrisma().user.findUnique({
56 | where: {
57 | email,
58 | },
59 | select: {
60 | id: true,
61 | },
62 | });
63 |
64 | const existingUserByUsername = await usePrisma().user.findUnique({
65 | where: {
66 | username,
67 | },
68 | select: {
69 | id: true,
70 | },
71 | });
72 |
73 | if (existingUserByEmail || existingUserByUsername) {
74 | throw new HttpException(422, {
75 | errors: {
76 | ...(existingUserByEmail ? {email: ['has already been taken']} : {}),
77 | ...(existingUserByUsername ? {username: ['has already been taken']} : {}),
78 | },
79 | });
80 | }
81 | };
82 |
--------------------------------------------------------------------------------
/apps/documentation/src/content/docs/specifications/frontend/api.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: API
3 | ---
4 |
5 | This project provides you different solutions to test your frontend implementation with an API by:
6 |
7 | - [running our official backend implementation locally](#run-the-official-backend-implementation-locally)
8 | - [hosting your own API](#host-your-own-api)
9 | - [using the API deployed for the official demo](#demo-api)
10 |
11 | ## Run the official backend implementation locally
12 |
13 | The official backend implementation is open-sourced.
14 | You can find the GitHub repository [here](https://github.com/gothinkster/node-express-prisma-v1-official-app).
15 | The Readme will provide you guidances to start the server locally.
16 |
17 | :::info
18 | 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.
19 | :::
20 |
21 | ## Host your own API
22 |
23 | The official backend implementation includes a [**Deploy to Heroku** button](https://github.com/gothinkster/node-express-prisma-v1-official-app#deploy-to-heroku).
24 | This button provides you a quick and easy way to deploy the API on Heroku for your frontend implementation.
25 |
26 | :::caution
27 | The official backend implementation repository includes two branches:
28 |
29 | - the **main** branch which adheres to the RealWorld backend specs
30 | - the **limited** branch which includes limitations for public-hosted APIs
31 |
32 | The **limited** branch will be more suitable if you plan to host your implementation.
33 | [Here](#api-limitations) is the list of the limitations.
34 | :::
35 |
36 | ## Demo API
37 |
38 | This project provides you with a public hosted API to test your frontend implementations.
39 | Point your API requests to `https://api.realworld.io/api` and you're good to go!
40 |
41 | ### API Usage
42 |
43 | The API is freely available for public usage but its access is limited to RealWorld usage only: you won't be able to t consume it on its own but with a frontend application.
44 |
45 | ## API Limitations
46 |
47 | :::info
48 | To provide everyone a **safe** and **healthy** experience by not exposing free speech created content, the following limitations have been introduced in 2021
49 | :::
50 |
51 | The visibility of user content is limited :
52 |
53 | - logged out users see only content created by demo accounts
54 | - logged in users see only their content and the content created by demo accounts
55 |
--------------------------------------------------------------------------------
/apps/api/server/routes/api/articles/index.post.ts:
--------------------------------------------------------------------------------
1 | import articleMapper from "~/utils/article.mapper";
2 | import HttpException from "~/models/http-exception.model";
3 | import slugify from 'slugify';
4 | import {definePrivateEventHandler} from "~/auth-event-handler";
5 |
6 | export default definePrivateEventHandler(async (event, {auth}) => {
7 | const {article} = await readBody(event);
8 |
9 | const { title, description, body, tagList } = article;
10 | const tags = Array.isArray(tagList) ? tagList : [];
11 |
12 | if (!title) {
13 | throw new HttpException(422, { errors: { title: ["can't be blank"] } });
14 | }
15 |
16 | if (!description) {
17 | throw new HttpException(422, { errors: { description: ["can't be blank"] } });
18 | }
19 |
20 | if (!body) {
21 | throw new HttpException(422, { errors: { body: ["can't be blank"] } });
22 | }
23 |
24 | const slug = `${slugify(title)}-${auth.id}`;
25 |
26 | const existingTitle = await usePrisma().article.findUnique({
27 | where: {
28 | slug,
29 | },
30 | select: {
31 | slug: true,
32 | },
33 | });
34 |
35 | if (existingTitle) {
36 | throw new HttpException(422, { errors: { title: ['must be unique'] } });
37 | }
38 |
39 | const {
40 | authorId,
41 | id: articleId,
42 | ...createdArticle
43 | } = await usePrisma().article.create({
44 | data: {
45 | title,
46 | description,
47 | body,
48 | slug,
49 | tagList: {
50 | connectOrCreate: tags.map((tag: string) => ({
51 | create: { name: tag },
52 | where: { name: tag },
53 | })),
54 | },
55 | author: {
56 | connect: {
57 | id: auth.id,
58 | },
59 | },
60 | },
61 | include: {
62 | tagList: {
63 | select: {
64 | name: true,
65 | },
66 | },
67 | author: {
68 | select: {
69 | username: true,
70 | bio: true,
71 | image: true,
72 | followedBy: true,
73 | },
74 | },
75 | favoritedBy: true,
76 | _count: {
77 | select: {
78 | favoritedBy: true,
79 | },
80 | },
81 | },
82 | });
83 |
84 | return {article: articleMapper(createdArticle, auth.id)};
85 | });
86 |
--------------------------------------------------------------------------------
/apps/documentation/README.md:
--------------------------------------------------------------------------------
1 | # Starlight Starter Kit: Basics
2 |
3 | [](https://starlight.astro.build)
4 |
5 | ```
6 | npm create astro@latest -- --template starlight
7 | ```
8 |
9 | [](https://stackblitz.com/github/withastro/starlight/tree/main/examples/basics)
10 | [](https://codesandbox.io/p/sandbox/github/withastro/starlight/tree/main/examples/basics)
11 | [](https://app.netlify.com/start/deploy?repository=https://github.com/withastro/starlight&create_from_path=examples/basics)
12 | [](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fwithastro%2Fstarlight%2Ftree%2Fmain%2Fexamples%2Fbasics&project-name=my-starlight-docs&repository-name=my-starlight-docs)
13 |
14 | > 🧑🚀 **Seasoned astronaut?** Delete this file. Have fun!
15 |
16 | ## 🚀 Project Structure
17 |
18 | Inside of your Astro + Starlight project, you'll see the following folders and files:
19 |
20 | ```
21 | .
22 | ├── public/
23 | ├── src/
24 | │ ├── assets/
25 | │ ├── content/
26 | │ │ ├── docs/
27 | │ │ └── config.ts
28 | │ └── env.d.ts
29 | ├── astro.config.mjs
30 | ├── package.json
31 | └── tsconfig.json
32 | ```
33 |
34 | Starlight looks for `.md` or `.mdx` files in the `src/content/docs/` directory. Each file is exposed as a route based on its file name.
35 |
36 | Images can be added to `src/assets/` and embedded in Markdown with a relative link.
37 |
38 | Static assets, like favicons, can be placed in the `public/` directory.
39 |
40 | ## 🧞 Commands
41 |
42 | All commands are run from the root of the project, from a terminal:
43 |
44 | | Command | Action |
45 | | :------------------------ | :----------------------------------------------- |
46 | | `npm install` | Installs dependencies |
47 | | `npm run dev` | Starts local dev server at `localhost:4321` |
48 | | `npm run build` | Build your production site to `./dist/` |
49 | | `npm run preview` | Preview your build locally, before deploying |
50 | | `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
51 | | `npm run astro -- --help` | Get help using the Astro CLI |
52 |
53 | ## 👀 Want to learn more?
54 |
55 | Check out [Starlight’s docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [Astro Discord server](https://astro.build/chat).
56 |
--------------------------------------------------------------------------------
/apps/documentation/src/content/docs/implementation-creation/expectations.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Expectations
3 | ---
4 |
5 | ## Remember: Keep your codebases _simple_, yet _robust_.
6 |
7 | If a new developer to your framework comes along and takes longer than 10 minutes to grasp the high-level architecture, it's likely that you went a little overboard in the engineering department.
8 |
9 | Alternatively, you should _never_ forgo following fundamental best practices for the sake of simplicity, lest we teach that same newbie dev the _wrong_ way of doing things.
10 |
11 | The quality & architecture of Conduit implementations should reflect something similar to an early-stage startup's MVP: functionally complete & stable, but not unnecessarily over-engineered.
12 |
13 | ## To write tests, or to not write tests?
14 |
15 | **TL;DR** — we require a minimum of **one** unit test with every repo, but we'd definitely prefer all of them to include excellent testing coverage if the maintainers are willing to add it (or if someone in the community is kind enough to make a pull request :)
16 |
17 | We believe that tests are a good concept, and we are big supporters of TDD in general. Building Conduit implementations without complete testing coverage, on the other hand, is a significant time commitment in and of itself, therefore we didn't include it in the spec at first since we believed that if people wanted it, it would be a fantastic "extra credit" aim for the repo. For example, a request for unit tests was made in our Angular 2 repo, and several fantastic community members are presently working on a PR to address it.
18 |
19 | Another reason we didn’t include them in the spec is from the "Golden Rule" above:
20 |
21 | > The quality & architecture of Conduit implementations should reflect something similar to an early-stage startup's MVP: functionally complete & stable, but not unnecessarily over-engineered.
22 |
23 | Most startups we know that work in consumer-facing apps (like Conduit) don’t apply TDD/testing until they have a solid product-market fit, which is smart because they then spend most of their time iterating on product & UI and thus are far more likely to find PMF.
24 |
25 | This doesn’t mean that TDD/testing === over-engineering, but in certain circumstances that statement does evaluate true (ex: consumer product finding PMF, side-projects, robust prototypes, etc).
26 |
27 | That said, we do _prefer_ that every repo includes excellent tests that are exemplary of TDD/testing with that framework 👍
28 |
29 | ## Other Expectations
30 |
31 | - All the required features (see specs) should be implemented.
32 | - You should publish your implementation on a dedicated GitHub repository with the "Issues" section open.
33 | - You should provide a README that presents an overview of your implementation and explains how to run it locally.
34 | - The library/framework you are using should have at least 300 GitHub stars.
35 | - You should do your best to keep your implementation up to date.
36 |
--------------------------------------------------------------------------------
/apps/api/server/routes/api/articles/index.get.ts:
--------------------------------------------------------------------------------
1 | import articleMapper from "~/utils/article.mapper";
2 | import {definePrivateEventHandler} from "~/auth-event-handler";
3 |
4 | export default definePrivateEventHandler(async (event, {auth}) => {
5 | const query = getQuery(event);
6 |
7 | const andQueries = buildFindAllQuery(query, auth);
8 | const articlesCount = await usePrisma().article.count({
9 | where: {
10 | AND: andQueries,
11 | },
12 | });
13 |
14 | const articles = await usePrisma().article.findMany({
15 | omit: {
16 | body: true,
17 | updatedAt: true,
18 | },
19 | where: { AND: andQueries },
20 | orderBy: {
21 | createdAt: 'desc',
22 | },
23 | skip: Number(query.offset) || 0,
24 | take: Number(query.limit) || 10,
25 | include: {
26 | tagList: {
27 | select: {
28 | name: true,
29 | },
30 | },
31 | author: {
32 | select: {
33 | username: true,
34 | image: true,
35 | followedBy: true,
36 | },
37 | },
38 | favoritedBy: true,
39 | _count: {
40 | select: {
41 | favoritedBy: true,
42 | },
43 | },
44 | },
45 | });
46 |
47 | return {
48 | articles: articles.map((article: any) => articleMapper(article, auth.id)),
49 | articlesCount,
50 | };
51 | }, {requireAuth: false});
52 |
53 | const buildFindAllQuery = (query: any, auth: {id: number} | undefined) => {
54 | const queries: any = [];
55 | const orAuthorQuery = [];
56 | const andAuthorQuery = [];
57 |
58 | orAuthorQuery.push({
59 | demo: {
60 | equals: true,
61 | },
62 | });
63 |
64 | if (auth?.id) {
65 | orAuthorQuery.push({
66 | id: {
67 | equals: auth?.id,
68 | },
69 | });
70 | }
71 |
72 | if ('author' in query) {
73 | andAuthorQuery.push({
74 | username: {
75 | equals: query.author,
76 | },
77 | });
78 | }
79 |
80 | const authorQuery = {
81 | author: {
82 | OR: orAuthorQuery,
83 | AND: andAuthorQuery,
84 | },
85 | };
86 |
87 | queries.push(authorQuery);
88 |
89 | if ('tag' in query) {
90 | queries.push({
91 | tagList: {
92 | some: {
93 | name: query.tag,
94 | },
95 | },
96 | });
97 | }
98 |
99 | if ('favorited' in query) {
100 | queries.push({
101 | favoritedBy: {
102 | some: {
103 | username: {
104 | equals: query.favorited,
105 | },
106 | },
107 | },
108 | });
109 | }
110 |
111 | return queries;
112 | };
113 |
--------------------------------------------------------------------------------
/apps/api/server/routes/api/articles/[slug]/index.put.ts:
--------------------------------------------------------------------------------
1 | import HttpException from "~/models/http-exception.model";
2 | import articleMapper from "~/utils/article.mapper";
3 | import slugify from 'slugify';
4 | import {definePrivateEventHandler} from "~/auth-event-handler";
5 |
6 | export default definePrivateEventHandler(async (event, {auth}) => {
7 | const {article} = await readBody(event);
8 | const slug = getRouterParam(event, 'slug');
9 |
10 | let newSlug = null;
11 |
12 | const existingArticle = await usePrisma().article.findFirst({
13 | where: {
14 | slug,
15 | },
16 | select: {
17 | author: {
18 | select: {
19 | id: true,
20 | username: true,
21 | },
22 | },
23 | },
24 | });
25 |
26 | if (!existingArticle) {
27 | throw new HttpException(404, {});
28 | }
29 |
30 | if (existingArticle.author.id !== auth.id) {
31 | throw new HttpException(403, {
32 | message: 'You are not authorized to update this article',
33 | });
34 | }
35 |
36 | if (article.title) {
37 | newSlug = `${slugify(article.title)}-${auth.id}`;
38 |
39 | if (newSlug !== slug) {
40 | const existingTitle = await usePrisma().article.findFirst({
41 | where: {
42 | slug: newSlug,
43 | },
44 | select: {
45 | slug: true,
46 | },
47 | });
48 |
49 | if (existingTitle) {
50 | throw new HttpException(422, { errors: { title: ['must be unique'] } });
51 | }
52 | }
53 | }
54 |
55 | const tagList =
56 | Array.isArray(article.tagList) && article.tagList?.length
57 | ? article.tagList.map((tag: string) => ({
58 | create: { name: tag },
59 | where: { name: tag },
60 | }))
61 | : [];
62 |
63 | await disconnectArticlesTags(slug);
64 |
65 | const updatedArticle = await usePrisma().article.update({
66 | where: {
67 | slug,
68 | },
69 | data: {
70 | ...(article.title ? { title: article.title } : {}),
71 | ...(article.body ? { body: article.body } : {}),
72 | ...(article.description ? { description: article.description } : {}),
73 | ...(newSlug ? { slug: newSlug } : {}),
74 | updatedAt: new Date(),
75 | tagList: {
76 | connectOrCreate: tagList,
77 | },
78 | },
79 | include: {
80 | tagList: {
81 | select: {
82 | name: true,
83 | },
84 | },
85 | author: {
86 | select: {
87 | username: true,
88 | bio: true,
89 | image: true,
90 | followedBy: true,
91 | },
92 | },
93 | favoritedBy: true,
94 | _count: {
95 | select: {
96 | favoritedBy: true,
97 | },
98 | },
99 | },
100 | });
101 |
102 | return {article: articleMapper(updatedArticle, auth.id)};
103 | });
104 |
105 | const disconnectArticlesTags = async (slug: string) => {
106 | await usePrisma().article.update({
107 | where: {
108 | slug,
109 | },
110 | data: {
111 | tagList: {
112 | set: [],
113 | },
114 | },
115 | });
116 | };
117 |
--------------------------------------------------------------------------------
/apps/api/prisma/migrations/20241009081140_init/migration.sql:
--------------------------------------------------------------------------------
1 | -- CreateTable
2 | CREATE TABLE "Article" (
3 | "id" INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT,
4 | "slug" TEXT NOT NULL,
5 | "title" TEXT NOT NULL,
6 | "description" TEXT NOT NULL,
7 | "body" TEXT NOT NULL,
8 | "createdAt" DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP,
9 | "updatedAt" DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP,
10 | "authorId" INTEGER NOT NULL,
11 | CONSTRAINT "Article_authorId_fkey" FOREIGN KEY ("authorId") REFERENCES "User" ("id") ON DELETE CASCADE ON UPDATE CASCADE
12 | );
13 |
14 | -- CreateTable
15 | CREATE TABLE "Comment" (
16 | "id" INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT,
17 | "createdAt" DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP,
18 | "updatedAt" DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP,
19 | "body" TEXT NOT NULL,
20 | "articleId" INTEGER NOT NULL,
21 | "authorId" INTEGER NOT NULL,
22 | CONSTRAINT "Comment_articleId_fkey" FOREIGN KEY ("articleId") REFERENCES "Article" ("id") ON DELETE CASCADE ON UPDATE CASCADE,
23 | CONSTRAINT "Comment_authorId_fkey" FOREIGN KEY ("authorId") REFERENCES "User" ("id") ON DELETE CASCADE ON UPDATE CASCADE
24 | );
25 |
26 | -- CreateTable
27 | CREATE TABLE "Tag" (
28 | "id" INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT,
29 | "name" TEXT NOT NULL
30 | );
31 |
32 | -- CreateTable
33 | CREATE TABLE "User" (
34 | "id" INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT,
35 | "email" TEXT NOT NULL,
36 | "username" TEXT NOT NULL,
37 | "password" TEXT NOT NULL,
38 | "image" TEXT DEFAULT 'https://api.realworld.io/images/smiley-cyrus.jpeg',
39 | "bio" TEXT,
40 | "demo" BOOLEAN NOT NULL DEFAULT false
41 | );
42 |
43 | -- CreateTable
44 | CREATE TABLE "_ArticleToTag" (
45 | "A" INTEGER NOT NULL,
46 | "B" INTEGER NOT NULL,
47 | CONSTRAINT "_ArticleToTag_A_fkey" FOREIGN KEY ("A") REFERENCES "Article" ("id") ON DELETE CASCADE ON UPDATE CASCADE,
48 | CONSTRAINT "_ArticleToTag_B_fkey" FOREIGN KEY ("B") REFERENCES "Tag" ("id") ON DELETE CASCADE ON UPDATE CASCADE
49 | );
50 |
51 | -- CreateTable
52 | CREATE TABLE "_UserFavorites" (
53 | "A" INTEGER NOT NULL,
54 | "B" INTEGER NOT NULL,
55 | CONSTRAINT "_UserFavorites_A_fkey" FOREIGN KEY ("A") REFERENCES "Article" ("id") ON DELETE CASCADE ON UPDATE CASCADE,
56 | CONSTRAINT "_UserFavorites_B_fkey" FOREIGN KEY ("B") REFERENCES "User" ("id") ON DELETE CASCADE ON UPDATE CASCADE
57 | );
58 |
59 | -- CreateTable
60 | CREATE TABLE "_UserFollows" (
61 | "A" INTEGER NOT NULL,
62 | "B" INTEGER NOT NULL,
63 | CONSTRAINT "_UserFollows_A_fkey" FOREIGN KEY ("A") REFERENCES "User" ("id") ON DELETE CASCADE ON UPDATE CASCADE,
64 | CONSTRAINT "_UserFollows_B_fkey" FOREIGN KEY ("B") REFERENCES "User" ("id") ON DELETE CASCADE ON UPDATE CASCADE
65 | );
66 |
67 | -- CreateIndex
68 | CREATE UNIQUE INDEX "Article_slug_key" ON "Article"("slug");
69 |
70 | -- CreateIndex
71 | CREATE UNIQUE INDEX "Tag_name_key" ON "Tag"("name");
72 |
73 | -- CreateIndex
74 | CREATE UNIQUE INDEX "User_email_key" ON "User"("email");
75 |
76 | -- CreateIndex
77 | CREATE UNIQUE INDEX "User_username_key" ON "User"("username");
78 |
79 | -- CreateIndex
80 | CREATE UNIQUE INDEX "_ArticleToTag_AB_unique" ON "_ArticleToTag"("A", "B");
81 |
82 | -- CreateIndex
83 | CREATE INDEX "_ArticleToTag_B_index" ON "_ArticleToTag"("B");
84 |
85 | -- CreateIndex
86 | CREATE UNIQUE INDEX "_UserFavorites_AB_unique" ON "_UserFavorites"("A", "B");
87 |
88 | -- CreateIndex
89 | CREATE INDEX "_UserFavorites_B_index" ON "_UserFavorites"("B");
90 |
91 | -- CreateIndex
92 | CREATE UNIQUE INDEX "_UserFollows_AB_unique" ON "_UserFollows"("A", "B");
93 |
94 | -- CreateIndex
95 | CREATE INDEX "_UserFollows_B_index" ON "_UserFollows"("B");
96 |
--------------------------------------------------------------------------------
/apps/documentation/src/content/docs/community/authors.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Authors
3 | ---
4 |
5 | # Who currently maintain the project
6 |
7 | #### [Gérôme Grignon](https://github.com/geromegrignon) - Maintainer
8 |
9 | 
10 |
11 | Gérôme is a Software Engineer at Lucca. He's an open-source enthusiast.12 | 13 | #### [Manuel Vila](https://github.com/mvila) - Maintainer 14 | 15 |
16 |
17 | Manuel is an independent Software Engineer, creator of the [Layr framework](https://layrjs.com) and the [CodebaseShow website](https://codebase.show/).18 | 19 | 20 | 21 | # Who create it 22 | 23 | RealWorld would not be possible without the [open source community](https://realworld-docs.netlify.app/docs/community/special-thanks) continuously helping push the project forward. In addition, the former team was composed of: 24 | 25 | #### [Anish Karandikar](https://github.com/anishkny) - Core Maintainer 26 | 27 |
28 |
29 | MathWorker, ex-Google, ex-Computational Fluid Dynamicist, forever lover of tech & humanities ❤️
30 |
31 | #### [Cameron Chapman](https://github.com/Cameron-C-Chapman) - Core Maintainer
32 |
33 | 
34 |
35 | Cameron Chapman is a Software Engineer at FanThreeSixty. He's an open source enthusiast and is helping to teach a local web development boot camp at Kansas University.
36 |
37 | #### [Eric Simons](https://twitter.com/ericsimons40) - Founder/Maintainer
38 |
39 | 
40 |
41 | Eric is a Software Engineer, UI Designer, and author of many technical books & tutorials. He oversees the project direction, maintenance and organizes the planning and development efforts of the team.
42 |
43 | #### [Albert Pai](https://twitter.com/iamalbertpai) - Founder/Maintainer
44 |
45 | 
46 |
47 | Albert is a Software Engineer, DevOps ninja, and author of many technical books & tutorials. He oversees the project direction, maintenance and organizes the planning and development efforts of the team.
48 |
49 | #### [Thinkster](https://twitter.com/gothinkster) - Funded
50 |
51 | 
52 |
53 | [Thinkster](https://thinkster.io) creates high quality resources that help Javascript developers succeed. The RealWorld project wouldn't exist without their funding, so please consider investing in [a Pro subscription](https://thinkster.io/pro) to help support us!
54 |
55 | #### [James Brewer](https://twitter.com/brwr_) - Admin
56 |
57 | 
58 |
59 | James is a Software Engineer at Square and a contributor to the Django project. He created & maintained the RW Django codebase and continually provides guidance for the RealWorld project itself.
60 |
61 | #### [Sandeesh S.](https://github.com/sandeesh) - Admin
62 |
63 | 
64 |
65 | Full stack developer, Laravel enthusiast, Digital marketing specialist and an avid gamer.
66 |
--------------------------------------------------------------------------------
/apps/documentation/src/content/docs/specifications/backend/api-response-format.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: API response format
3 | ---
4 |
5 | ## JSON Objects returned by API:
6 |
7 | Make sure the right content type like `Content-Type: application/json; charset=utf-8` is correctly returned.
8 |
9 | ### Users (for authentication)
10 |
11 | ```JSON
12 | {
13 | "user": {
14 | "email": "jake@jake.jake",
15 | "token": "jwt.token.here",
16 | "username": "jake",
17 | "bio": "I work at statefarm",
18 | "image": null
19 | }
20 | }
21 | ```
22 |
23 | ### Profile
24 |
25 | ```JSON
26 | {
27 | "profile": {
28 | "username": "jake",
29 | "bio": "I work at statefarm",
30 | "image": "https://api.realworld.io/images/smiley-cyrus.jpg",
31 | "following": false
32 | }
33 | }
34 | ```
35 |
36 | ### Single Article
37 |
38 | ```JSON
39 | {
40 | "article": {
41 | "slug": "how-to-train-your-dragon",
42 | "title": "How to train your dragon",
43 | "description": "Ever wonder how?",
44 | "body": "It takes a Jacobian",
45 | "tagList": ["dragons", "training"],
46 | "createdAt": "2016-02-18T03:22:56.637Z",
47 | "updatedAt": "2016-02-18T03:48:35.824Z",
48 | "favorited": false,
49 | "favoritesCount": 0,
50 | "author": {
51 | "username": "jake",
52 | "bio": "I work at statefarm",
53 | "image": "https://i.stack.imgur.com/xHWG8.jpg",
54 | "following": false
55 | }
56 | }
57 | }
58 | ```
59 |
60 | ### Multiple Articles
61 |
62 | :::caution
63 | Starting from the 2024/08/16, the endpoints retrieving a list of articles do no longer return the body of an article for performance reasons.
64 | It affcts:
65 | - `GET /api/articles`
66 | - `GET /api/articles/feed`
67 | :::
68 |
69 | ```JSON
70 | {
71 | "articles":[{
72 | "slug": "how-to-train-your-dragon",
73 | "title": "How to train your dragon",
74 | "description": "Ever wonder how?",
75 | "tagList": ["dragons", "training"],
76 | "createdAt": "2016-02-18T03:22:56.637Z",
77 | "updatedAt": "2016-02-18T03:48:35.824Z",
78 | "favorited": false,
79 | "favoritesCount": 0,
80 | "author": {
81 | "username": "jake",
82 | "bio": "I work at statefarm",
83 | "image": "https://i.stack.imgur.com/xHWG8.jpg",
84 | "following": false
85 | }
86 | }, {
87 | "slug": "how-to-train-your-dragon-2",
88 | "title": "How to train your dragon 2",
89 | "description": "So toothless",
90 | "tagList": ["dragons", "training"],
91 | "createdAt": "2016-02-18T03:22:56.637Z",
92 | "updatedAt": "2016-02-18T03:48:35.824Z",
93 | "favorited": false,
94 | "favoritesCount": 0,
95 | "author": {
96 | "username": "jake",
97 | "bio": "I work at statefarm",
98 | "image": "https://i.stack.imgur.com/xHWG8.jpg",
99 | "following": false
100 | }
101 | }],
102 | "articlesCount": 2
103 | }
104 | ```
105 |
106 | ### Single Comment
107 |
108 | ```JSON
109 | {
110 | "comment": {
111 | "id": 1,
112 | "createdAt": "2016-02-18T03:22:56.637Z",
113 | "updatedAt": "2016-02-18T03:22:56.637Z",
114 | "body": "It takes a Jacobian",
115 | "author": {
116 | "username": "jake",
117 | "bio": "I work at statefarm",
118 | "image": "https://i.stack.imgur.com/xHWG8.jpg",
119 | "following": false
120 | }
121 | }
122 | }
123 | ```
124 |
125 | ### Multiple Comments
126 |
127 | ```JSON
128 | {
129 | "comments": [{
130 | "id": 1,
131 | "createdAt": "2016-02-18T03:22:56.637Z",
132 | "updatedAt": "2016-02-18T03:22:56.637Z",
133 | "body": "It takes a Jacobian",
134 | "author": {
135 | "username": "jake",
136 | "bio": "I work at statefarm",
137 | "image": "https://i.stack.imgur.com/xHWG8.jpg",
138 | "following": false
139 | }
140 | }]
141 | }
142 | ```
143 |
144 | ### List of Tags
145 |
146 | ```JSON
147 | {
148 | "tags": [
149 | "reactjs",
150 | "angularjs"
151 | ]
152 | }
153 | ```
154 |
--------------------------------------------------------------------------------
/media/mobile_icons/ios/AppIcon.appiconset/Contents.json:
--------------------------------------------------------------------------------
1 | {
2 | "images": [
3 | {
4 | "idiom": "iphone",
5 | "size": "20x20",
6 | "scale": "2x",
7 | "filename": "Icon-App-20x20@2x.png"
8 | },
9 | {
10 | "idiom": "iphone",
11 | "size": "20x20",
12 | "scale": "3x",
13 | "filename": "Icon-App-20x20@3x.png"
14 | },
15 | {
16 | "idiom": "iphone",
17 | "size": "29x29",
18 | "scale": "1x",
19 | "filename": "Icon-App-29x29@1x.png"
20 | },
21 | {
22 | "idiom": "iphone",
23 | "size": "29x29",
24 | "scale": "2x",
25 | "filename": "Icon-App-29x29@2x.png"
26 | },
27 | {
28 | "idiom": "iphone",
29 | "size": "29x29",
30 | "scale": "3x",
31 | "filename": "Icon-App-29x29@3x.png"
32 | },
33 | {
34 | "idiom": "iphone",
35 | "size": "40x40",
36 | "scale": "1x",
37 | "filename": "Icon-App-40x40@1x.png"
38 | },
39 | {
40 | "idiom": "iphone",
41 | "size": "40x40",
42 | "scale": "2x",
43 | "filename": "Icon-App-40x40@2x.png"
44 | },
45 | {
46 | "idiom": "iphone",
47 | "size": "40x40",
48 | "scale": "3x",
49 | "filename": "Icon-App-40x40@3x.png"
50 | },
51 | {
52 | "idiom": "iphone",
53 | "size": "57x57",
54 | "scale": "1x",
55 | "filename": "Icon-App-57x57@1x.png"
56 | },
57 | {
58 | "idiom": "iphone",
59 | "size": "57x57",
60 | "scale": "2x",
61 | "filename": "Icon-App-57x57@2x.png"
62 | },
63 | {
64 | "idiom": "iphone",
65 | "size": "60x60",
66 | "scale": "1x",
67 | "filename": "Icon-App-60x60@1x.png"
68 | },
69 | {
70 | "idiom": "iphone",
71 | "size": "60x60",
72 | "scale": "2x",
73 | "filename": "Icon-App-60x60@2x.png"
74 | },
75 | {
76 | "idiom": "iphone",
77 | "size": "60x60",
78 | "scale": "3x",
79 | "filename": "Icon-App-60x60@3x.png"
80 | },
81 | {
82 | "idiom": "iphone",
83 | "size": "76x76",
84 | "scale": "1x",
85 | "filename": "Icon-App-76x76@1x.png"
86 | },
87 | {
88 | "idiom": "ipad",
89 | "size": "20x20",
90 | "scale": "1x",
91 | "filename": "Icon-App-20x20@1x.png"
92 | },
93 | {
94 | "idiom": "ipad",
95 | "size": "20x20",
96 | "scale": "2x",
97 | "filename": "Icon-App-20x20@2x.png"
98 | },
99 | {
100 | "idiom": "ipad",
101 | "size": "29x29",
102 | "scale": "1x",
103 | "filename": "Icon-App-29x29@1x.png"
104 | },
105 | {
106 | "idiom": "ipad",
107 | "size": "29x29",
108 | "scale": "2x",
109 | "filename": "Icon-App-29x29@2x.png"
110 | },
111 | {
112 | "idiom": "ipad",
113 | "size": "40x40",
114 | "scale": "1x",
115 | "filename": "Icon-App-40x40@1x.png"
116 | },
117 | {
118 | "idiom": "ipad",
119 | "size": "40x40",
120 | "scale": "2x",
121 | "filename": "Icon-App-40x40@2x.png"
122 | },
123 | {
124 | "size": "50x50",
125 | "idiom": "ipad",
126 | "filename": "Icon-Small-50x50@1x.png",
127 | "scale": "1x"
128 | },
129 | {
130 | "size": "50x50",
131 | "idiom": "ipad",
132 | "filename": "Icon-Small-50x50@2x.png",
133 | "scale": "2x"
134 | },
135 | {
136 | "idiom": "ipad",
137 | "size": "72x72",
138 | "scale": "1x",
139 | "filename": "Icon-App-72x72@1x.png"
140 | },
141 | {
142 | "idiom": "ipad",
143 | "size": "72x72",
144 | "scale": "2x",
145 | "filename": "Icon-App-72x72@2x.png"
146 | },
147 | {
148 | "idiom": "ipad",
149 | "size": "76x76",
150 | "scale": "1x",
151 | "filename": "Icon-App-76x76@1x.png"
152 | },
153 | {
154 | "idiom": "ipad",
155 | "size": "76x76",
156 | "scale": "2x",
157 | "filename": "Icon-App-76x76@2x.png"
158 | },
159 | {
160 | "idiom": "ipad",
161 | "size": "76x76",
162 | "scale": "3x",
163 | "filename": "Icon-App-76x76@3x.png"
164 | },
165 | {
166 | "idiom": "ipad",
167 | "size": "83.5x83.5",
168 | "scale": "2x",
169 | "filename": "Icon-App-83.5x83.5@2x.png"
170 | }
171 | ],
172 | "info": {
173 | "version": 1,
174 | "author": "makeappicon"
175 | }
176 | }
177 |
--------------------------------------------------------------------------------
/CODE_OF_CONDUCT.md:
--------------------------------------------------------------------------------
1 | # Contributor Covenant Code of Conduct
2 |
3 | ## Our Pledge
4 |
5 | We as members, contributors, and leaders pledge to make participation in our
6 | community a harassment-free experience for everyone, regardless of age, body
7 | size, visible or invisible disability, ethnicity, sex characteristics, gender
8 | identity and expression, level of experience, education, socio-economic status,
9 | nationality, personal appearance, race, religion, or sexual identity
10 | and orientation.
11 |
12 | We pledge to act and interact in ways that contribute to an open, welcoming,
13 | diverse, inclusive, and healthy community.
14 |
15 | ## Our Standards
16 |
17 | Examples of behavior that contributes to a positive environment for our
18 | community include:
19 |
20 | - Demonstrating empathy and kindness toward other people
21 | - Being respectful of differing opinions, viewpoints, and experiences
22 | - Giving and gracefully accepting constructive feedback
23 | - Accepting responsibility and apologizing to those affected by our mistakes,
24 | and learning from the experience
25 | - Focusing on what is best not just for us as individuals, but for the
26 | overall community
27 |
28 | Examples of unacceptable behavior include:
29 |
30 | - The use of sexualized language or imagery, and sexual attention or
31 | advances of any kind
32 | - Trolling, insulting or derogatory comments, and personal or political attacks
33 | - Public or private harassment
34 | - Publishing others' private information, such as a physical or email
35 | address, without their explicit permission
36 | - Other conduct which could reasonably be considered inappropriate in a
37 | professional setting
38 |
39 | ## Enforcement Responsibilities
40 |
41 | Community leaders are responsible for clarifying and enforcing our standards of
42 | acceptable behavior and will take appropriate and fair corrective action in
43 | response to any behavior that they deem inappropriate, threatening, offensive,
44 | or harmful.
45 |
46 | Community leaders have the right and responsibility to remove, edit, or reject
47 | comments, commits, code, wiki edits, issues, and other contributions that are
48 | not aligned to this Code of Conduct, and will communicate reasons for moderation
49 | decisions when appropriate.
50 |
51 | ## Scope
52 |
53 | This Code of Conduct applies within all community spaces, and also applies when
54 | an individual is officially representing the community in public spaces.
55 | Examples of representing our community include using an official e-mail address,
56 | posting via an official social media account, or acting as an appointed
57 | representative at an online or offline event.
58 |
59 | ## Enforcement
60 |
61 | Instances of abusive, harassing, or otherwise unacceptable behavior may be
62 | reported to the community leaders responsible for enforcement at
63 | hello@thinkster.io.
64 | All complaints will be reviewed and investigated promptly and fairly.
65 |
66 | All community leaders are obligated to respect the privacy and security of the
67 | reporter of any incident.
68 |
69 | ## Enforcement Guidelines
70 |
71 | Community leaders will follow these Community Impact Guidelines in determining
72 | the consequences for any action they deem in violation of this Code of Conduct:
73 |
74 | ### 1. Correction
75 |
76 | **Community Impact**: Use of inappropriate language or other behavior deemed
77 | unprofessional or unwelcome in the community.
78 |
79 | **Consequence**: A private, written warning from community leaders, providing
80 | clarity around the nature of the violation and an explanation of why the
81 | behavior was inappropriate. A public apology may be requested.
82 |
83 | ### 2. Warning
84 |
85 | **Community Impact**: A violation through a single incident or series
86 | of actions.
87 |
88 | **Consequence**: A warning with consequences for continued behavior. No
89 | interaction with the people involved, including unsolicited interaction with
90 | those enforcing the Code of Conduct, for a specified period of time. This
91 | includes avoiding interactions in community spaces as well as external channels
92 | like social media. Violating these terms may lead to a temporary or
93 | permanent ban.
94 |
95 | ### 3. Temporary Ban
96 |
97 | **Community Impact**: A serious violation of community standards, including
98 | sustained inappropriate behavior.
99 |
100 | **Consequence**: A temporary ban from any sort of interaction or public
101 | communication with the community for a specified period of time. No public or
102 | private interaction with the people involved, including unsolicited interaction
103 | with those enforcing the Code of Conduct, is allowed during this period.
104 | Violating these terms may lead to a permanent ban.
105 |
106 | ### 4. Permanent Ban
107 |
108 | **Community Impact**: Demonstrating a pattern of violation of community
109 | standards, including sustained inappropriate behavior, harassment of an
110 | individual, or aggression toward or disparagement of classes of individuals.
111 |
112 | **Consequence**: A permanent ban from any sort of public interaction within
113 | the community.
114 |
115 | ## Attribution
116 |
117 | This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118 | version 2.0, available at
119 | https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120 |
121 | Community Impact Guidelines were inspired by [Mozilla's code of conduct
122 | enforcement ladder](https://github.com/mozilla/diversity).
123 |
124 | [homepage]: https://www.contributor-covenant.org
125 |
126 | For answers to common questions about this code of conduct, see the FAQ at
127 | https://www.contributor-covenant.org/faq. Translations are available at
128 | https://www.contributor-covenant.org/translations.
129 |
--------------------------------------------------------------------------------
/apps/documentation/src/assets/img/logo.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/apps/documentation/src/content/docs/specifications/backend/endpoints.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Endpoints
3 | ---
4 |
5 | ### Authentication Header:
6 |
7 | You can read the authentication header from the headers of the request
8 |
9 | `Authorization: Token jwt.token.here`
10 |
11 | ### Authentication:
12 |
13 | `POST /api/users/login`
14 |
15 | Example request body:
16 |
17 | ```JSON
18 | {
19 | "user":{
20 | "email": "jake@jake.jake",
21 | "password": "jakejake"
22 | }
23 | }
24 | ```
25 |
26 | No authentication required, returns a [User](/specifications/backend/api-response-format.md#users-for-authentication)
27 |
28 | Required fields: `email`, `password`
29 |
30 | ### Registration:
31 |
32 | `POST /api/users`
33 |
34 | Example request body:
35 |
36 | ```JSON
37 | {
38 | "user":{
39 | "username": "Jacob",
40 | "email": "jake@jake.jake",
41 | "password": "jakejake"
42 | }
43 | }
44 | ```
45 |
46 | No authentication required, returns a [User](/specifications/backend/api-response-format.md#users-for-authentication)
47 |
48 | Required fields: `email`, `username`, `password`
49 |
50 | ### Get Current User
51 |
52 | `GET /api/user`
53 |
54 | Authentication required, returns a [User](/specifications/backend/api-response-format.md#users-for-authentication) that's the current user
55 |
56 | ### Update User
57 |
58 | `PUT /api/user`
59 |
60 | Example request body:
61 |
62 | ```JSON
63 | {
64 | "user":{
65 | "email": "jake@jake.jake",
66 | "bio": "I like to skateboard",
67 | "image": "https://i.stack.imgur.com/xHWG8.jpg"
68 | }
69 | }
70 | ```
71 |
72 | Authentication required, returns the [User](/specifications/backend/api-response-format.md#users-for-authentication)
73 |
74 | Accepted fields: `email`, `username`, `password`, `image`, `bio`
75 |
76 | ### Get Profile
77 |
78 | `GET /api/profiles/:username`
79 |
80 | Authentication optional, returns a [Profile](/specifications/backend/api-response-format.md#profile)
81 |
82 | ### Follow user
83 |
84 | `POST /api/profiles/:username/follow`
85 |
86 | Authentication required, returns a [Profile](/specifications/backend/api-response-format.md#profile)
87 |
88 | No additional parameters required
89 |
90 | ### Unfollow user
91 |
92 | `DELETE /api/profiles/:username/follow`
93 |
94 | Authentication required, returns a [Profile](/specifications/backend/api-response-format.md#profile)
95 |
96 | No additional parameters required
97 |
98 | ### List Articles
99 |
100 | `GET /api/articles`
101 |
102 | Returns most recent articles globally by default, provide `tag`, `author` or `favorited` query parameter to filter results
103 |
104 | Query Parameters:
105 |
106 | Filter by tag:
107 |
108 | `?tag=AngularJS`
109 |
110 | Filter by author:
111 |
112 | `?author=jake`
113 |
114 | Favorited by user:
115 |
116 | `?favorited=jake`
117 |
118 | Limit number of articles (default is 20):
119 |
120 | `?limit=20`
121 |
122 | Offset/skip number of articles (default is 0):
123 |
124 | `?offset=0`
125 |
126 | Authentication optional, will return [multiple articles](/specifications/backend/api-response-format.md#multiple-articles), ordered by most recent first
127 |
128 | ### Feed Articles
129 |
130 | `GET /api/articles/feed`
131 |
132 | Can also take `limit` and `offset` query parameters like [List Articles](/specifications/backend/api-response-format.md#list-articles)
133 |
134 | Authentication required, will return [multiple articles](/specifications/backend/api-response-format.md#multiple-articles) created by followed users, ordered by most recent first.
135 |
136 | ### Get Article
137 |
138 | `GET /api/articles/:slug`
139 |
140 | No authentication required, will return [single article](/specifications/backend/api-response-format.md#single-article)
141 |
142 | ### Create Article
143 |
144 | `POST /api/articles`
145 |
146 | Example request body:
147 |
148 | ```JSON
149 | {
150 | "article": {
151 | "title": "How to train your dragon",
152 | "description": "Ever wonder how?",
153 | "body": "You have to believe",
154 | "tagList": ["reactjs", "angularjs", "dragons"]
155 | }
156 | }
157 | ```
158 |
159 | Authentication required, will return an [Article](/specifications/backend/api-response-format.md#single-article)
160 |
161 | Required fields: `title`, `description`, `body`
162 |
163 | Optional fields: `tagList` as an array of Strings
164 |
165 | ### Update Article
166 |
167 | `PUT /api/articles/:slug`
168 |
169 | Example request body:
170 |
171 | ```JSON
172 | {
173 | "article": {
174 | "title": "Did you train your dragon?"
175 | }
176 | }
177 | ```
178 |
179 | Authentication required, returns the updated [Article](/specifications/backend/api-response-format.md#single-article)
180 |
181 | Optional fields: `title`, `description`, `body`
182 |
183 | The `slug` also gets updated when the `title` is changed
184 |
185 | ### Delete Article
186 |
187 | `DELETE /api/articles/:slug`
188 |
189 | Authentication required
190 |
191 | ### Add Comments to an Article
192 |
193 | `POST /api/articles/:slug/comments`
194 |
195 | Example request body:
196 |
197 | ```JSON
198 | {
199 | "comment": {
200 | "body": "His name was my name too."
201 | }
202 | }
203 | ```
204 |
205 | Authentication required, returns the created [Comment](/specifications/backend/api-response-format.md#single-comment)
206 |
207 | Required field: `body`
208 |
209 | ### Get Comments from an Article
210 |
211 | `GET /api/articles/:slug/comments`
212 |
213 | Authentication optional, returns [multiple comments](/specifications/backend/api-response-format.md#multiple-comments)
214 |
215 | ### Delete Comment
216 |
217 | `DELETE /api/articles/:slug/comments/:id`
218 |
219 | Authentication required
220 |
221 | ### Favorite Article
222 |
223 | `POST /api/articles/:slug/favorite`
224 |
225 | Authentication required, returns the [Article](/specifications/backend/api-response-format.md#single-article)
226 |
227 | No additional parameters required
228 |
229 | ### Unfavorite Article
230 |
231 | `DELETE /api/articles/:slug/favorite`
232 |
233 | Authentication required, returns the [Article](/specifications/backend/api-response-format.md#single-article)
234 |
235 | No additional parameters required
236 |
237 | ### Get Tags
238 |
239 | `GET /api/tags`
240 |
241 | No authentication required, returns a [List of Tags](/specifications/backend/api-response-format.md#list-of-tags)
242 |
--------------------------------------------------------------------------------
/apps/documentation/astro.config.mjs:
--------------------------------------------------------------------------------
1 | import {defineConfig} from 'astro/config';
2 | import starlight from '@astrojs/starlight';
3 | import tailwind from "@astrojs/tailwind";
4 | import react from "@astrojs/react";
5 |
6 | /**
7 | * A Vite plugin that removes `.md` extensions from URLs during the build process.
8 | *
9 | * This plugin is useful when working with Markdown files in a static site generator
10 | * like Astro or Vite. It allows URLs to be served without the `.md` extension in
11 | * the final build, making the URLs cleaner (e.g., `/docs/page` instead of `/docs/page.md`).
12 | *
13 | * ## Example Usage
14 | * ```js
15 | * import { defineConfig } from 'astro/config';
16 | *
17 | * export default defineConfig({
18 | * vite: {
19 | * plugins: [removeMdExtension()],
20 | * },
21 | * });
22 | * ```
23 | *
24 | * @typedef {object} VitePlugin
25 | * @property {string} name - The name of the plugin, in this case, `remove-md-extension`.
26 | * @property {string} enforce - Specifies the plugin's enforcement stage, set to `pre`
27 | * to ensure that this plugin runs before other transformations during the build.
28 | * @property {function} transform - The function that processes each file, removing
29 | * `.md` extensions from the file content. It is called on every file during the build process.
30 | *
31 | * @returns {VitePlugin} A Vite-compatible plugin object that contains the `name`,
32 | * `enforce`, and `transform` properties, implementing the plugin functionality.
33 | *
34 | * ## Vite Plugin Object Structure
35 | * - `name`: The name of the plugin (`remove-md-extension`).
36 | * - `enforce`: Ensures the plugin runs early (`pre` stage).
37 | * - `transform(code: string, id: string): string`: The function that processes the content of `.md` files.
38 | *
39 | * @param {string} code - The content of the file being processed (e.g., the raw Markdown).
40 | * @param {string} id - The file identifier (usually the file path), used to check if the file ends in `.md`.
41 | * @returns {string} The modified file content, with any `.md` extensions in URLs removed.
42 | */
43 | function removeMdExtension() {
44 | return {
45 | name: 'remove-md-extension',
46 | enforce: 'pre',
47 | transform(code, id) {
48 | if (id.endsWith('.md')) {
49 | return code.replace(/\.md/g, '');
50 | }
51 | return code;
52 | },
53 | };
54 | };
55 |
56 | // https://astro.build/config
57 | export default defineConfig({
58 | integrations: [starlight({
59 | title: 'RealWorld',
60 | social: {
61 | github: 'https://github.com/gothinkster/realworld'
62 | },
63 | customCss: [
64 | './src/tailwind.css',
65 | ],
66 | sidebar: [
67 | {
68 | label: 'Implementation creation',
69 | items: [
70 | {
71 | label: 'Introduction',
72 | slug: 'implementation-creation/introduction',
73 | },
74 | {
75 | label: 'Features',
76 | slug: 'implementation-creation/features',
77 | },
78 | {
79 | label: 'Expectations',
80 | slug: 'implementation-creation/expectations',
81 | }
82 |
83 | ]
84 | },
85 | {
86 | label: 'Specifications',
87 | items: [
88 | {
89 | label: 'Frontend specifications',
90 | items: [
91 | {
92 | label: 'Templates',
93 | slug: 'specifications/frontend/templates',
94 | },
95 | {
96 | label: 'Styles',
97 | slug: 'specifications/frontend/styles',
98 | },
99 | {
100 | label: 'Routing',
101 | slug: 'specifications/frontend/routing',
102 | },
103 | {
104 | label: 'API',
105 | slug: 'specifications/frontend/api',
106 | },
107 | {
108 | label: 'Tests',
109 | slug: 'specifications/frontend/tests',
110 | }
111 | ]
112 | },
113 | {
114 | label: 'Backend specifications',
115 | items: [
116 | {
117 | label: 'Introduction',
118 | slug: 'specifications/backend/introduction',
119 | },
120 | {
121 | label: 'Endpoints',
122 | slug: 'specifications/backend/endpoints',
123 | },
124 | {
125 | label: 'API response format',
126 | slug: 'specifications/backend/api-response-format',
127 | },
128 | {
129 | label: 'CORS',
130 | slug: 'specifications/backend/cors',
131 | },
132 | {
133 | label: 'Error handling',
134 | slug: 'specifications/backend/error-handling',
135 | },
136 | {
137 | label: 'Postman',
138 | slug: 'specifications/backend/postman',
139 | },
140 | {
141 | label: 'Tests',
142 | slug: 'specifications/backend/tests',
143 | }
144 | ]
145 | },
146 | {
147 | label: 'Mobile specifications',
148 | slug: 'specifications/mobile-specs/introduction'
149 | }
150 | ]
151 | },
152 | {
153 | label: 'Community',
154 | items: [
155 | // Each item here is one entry in the navigation menu.
156 | {
157 | label: 'Authors',
158 | slug: 'community/authors',
159 | },
160 | {
161 | label: 'Resources',
162 | slug: 'community/resources',
163 | },
164 | {
165 | label: 'Special Thanks',
166 | slug: 'community/special-thanks',
167 | }
168 | ]
169 | }
170 | ]
171 | }), tailwind({
172 | applyBaseStyles: false,
173 | })],
174 | vite: {
175 | plugins: [removeMdExtension()],
176 | }
177 | });
178 |
--------------------------------------------------------------------------------
/apps/documentation/src/assets/img/codebaseshow-logo.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/CONTRIBUTING.md:
--------------------------------------------------------------------------------
1 | # Contributing to RealWorld
2 |
3 | We would love for you to contribute to RealWorld and help make it even better than it is
4 | today! As a contributor, here are the guidelines we would like you to follow:
5 |
6 | - [Code of Conduct](#coc)
7 | - [Question or Problem?](#question)
8 | - [Issues and Bugs](#issue)
9 | - [Feature Requests](#feature)
10 | - [Submission Guidelines](#submit)
11 | - [Coding Rules](#rules)
12 | - [Commit Message Guidelines](#commit)
13 |
14 | ## Code of Conduct
15 |
16 | Help us keep RealWorld open and inclusive. Please read and follow our [Code of Conduct][coc].
17 |
18 | ## Got a Question or Problem?
19 |
20 | Do not open issues for general support questions as we want to keep GitHub issues for bug reports and feature requests.
21 | For open discussions, we encourage you to use the [Github Discussions][github-discussions] channels.
22 |
23 | ## Interested in creating Conduit for your framework?
24 |
25 | To create an official implementation of Conduit, check out our [Github Discussions](https://github.com/gothinkster/realworld/discussions/categories/wip-implementations) and see if anyone else has requested and/or is already working on your framework.
26 | If not, feel free to start working on one!
27 |
28 | Start [here][github-spec]!
29 |
30 | ## Found a Bug?
31 |
32 | If you find a bug in the project, you can help us by
33 | [submitting an issue][github-issue] to our [GitHub Repository][github]. Even better, you can
34 | [submit a Pull Request](#submit-pr) with a fix.
35 |
36 | ## Missing a Feature?
37 |
38 | You can _request_ a new feature by [submitting an issue](#submit-issue) to our GitHub
39 | repository.
40 |
41 | If you would like to _implement_ a new feature, please submit an issue with
42 | a proposal for your work **FIRST**, to be sure that we can use it.
43 | Please consider what kind of change it is:
44 |
45 | - For a **Major Feature**, first open an issue and outline your proposal so that it can be
46 | discussed. This will also allow us to better coordinate our efforts, prevent duplication of work,
47 | and help you to craft the change so that it is successfully accepted into the project.
48 | - **Small Features** can be crafted and directly [submitted as a Pull Request](#submit-pr).
49 |
50 | ## Submission Guidelines
51 |
52 | ### Submitting an Issue
53 |
54 | Before you submit an issue, please search the issue tracker, maybe an issue for your problem already exists and the discussion might inform you of workarounds readily available.
55 |
56 | You can file new issues by selecting from our [new issue templates][github-choose] and filling out the issue template.
57 |
58 | ### Submitting a Pull Request (PR)
59 |
60 | Before you submit your Pull Request (PR) consider the following guidelines:
61 |
62 | 1. Search [GitHub](https://github.com/gothinkster/realworld/pulls) for an open or closed PR
63 | that relates to your submission. You don't want to duplicate effort.
64 | 1. Be sure that an issue describes the problem you're fixing, or documents the design for the feature you'd like to add.
65 | Discussing the design up front helps to ensure that we're ready to accept your work.
66 | 1. Fork the gothinkster/realworld repo.
67 | 1. Make your changes in a new git branch:
68 |
69 | ```bash
70 | git checkout -b my-fix-branch master
71 | ```
72 |
73 | 1. Create your patch.
74 |
75 | 1. Commit your changes using a descriptive commit message that follows our
76 | [commit message conventions](#commit).
77 |
78 | 1. Push your branch to GitHub:
79 |
80 | ```bash
81 | git push origin my-fix-branch
82 | ```
83 |
84 | 1. In GitHub, send a pull request to `realworld:master`.
85 |
86 | - If we suggest changes then:
87 |
88 | - Make the required updates.
89 | - Rebase your branch and force push to your GitHub repository (this will update your Pull Request):
90 |
91 | ```bash
92 | git rebase master -i
93 | git push -f
94 | ```
95 |
96 | That's it! Thank you for your contribution!
97 |
98 | #### After your pull request is merged
99 |
100 | After your pull request is merged, you can safely delete your branch and pull the changes
101 | from the master (upstream) repository:
102 |
103 | - Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:
104 |
105 | ```bash
106 | git push origin --delete my-fix-branch
107 | ```
108 |
109 | - Check out the master branch:
110 |
111 | ```bash
112 | git checkout master -f
113 | ```
114 |
115 | - Delete the local branch:
116 |
117 | ```bash
118 | git branch -D my-fix-branch
119 | ```
120 |
121 | - Update your master with the latest upstream version:
122 |
123 | ```bash
124 | git pull --ff upstream master
125 | ```
126 |
127 | ## Commit Message Guidelines
128 |
129 | > These guidelines have been added to the project starting from