Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/reck1ess/next-realworld-example-app
Exemplary real world application built with Next.js + SWR
https://github.com/reck1ess/next-realworld-example-app
Last synced: 7 days ago
JSON representation
Exemplary real world application built with Next.js + SWR
- Host: GitHub
- URL: https://github.com/reck1ess/next-realworld-example-app
- Owner: reck1ess
- Created: 2020-01-25T06:38:05.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-05-15T09:32:21.000Z (6 months ago)
- Last Synced: 2024-06-08T12:34:59.774Z (5 months ago)
- Language: TypeScript
- Homepage: https://next-realworld-example-app.now.sh
- Size: 595 KB
- Stars: 815
- Watchers: 11
- Forks: 245
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 
> ### Next.js + SWR codebase containing real world examples (CRUD, auth, advanced patterns, etc) that adheres to the [RealWorld](https://github.com/gothinkster/realworld-example-apps) spec and API.
### [Demo](https://next-realworld.now.sh/) [RealWorld](https://github.com/gothinkster/realworld)
Originally created for this [GH issue](https://github.com/gothinkster/realworld/issues/336). The codebase is now feature complete; please submit bug fixes via pull requests & feedback via issues.
We're currently working on some docs for the codebase (explaining where functionality is located, how it works, etc) but most things should be self explanatory if you have a minimal understanding of Next.js/SWR.
## Getting started
You can view a live demo over at [https://next-realworld.now.sh/](https://next-realworld.now.sh/)
To get the frontend running locally:
- Clone this repo
- `npm install` to install all dependencies
- `npm run dev` to start the local server
### Making requests to the backend API
For convenience, we have a live API server running at `https://conduit.productionready.io/api` for the application to make requests against. You can view [the API spec here](https://github.com/GoThinkster/productionready/blob/master/api) which contains all routes & responses for the server.
The source code for the backend server (available for Node, Rails and Django) can be found in the [main RealWorld repo](https://github.com/gothinkster/realworld).
If you want to change the API URL to a local server, simply edit `lib/utils/constant.js` and change `SERVER_BASE_URL` to the local server's URL (i.e. `localhost:3000/api`)
## Functionality overview
The example application is a social blogging site (i.e. a Medium.com clone) called "Conduit". It uses a custom API for all requests, including authentication. You can view a live demo over at [https://next-realworld.now.sh/](https://next-realworld.now.sh/)
**General functionality:**
- Authenticate users via JWT (login/register pages + logout button on settings page)
- CRU\* users (sign up & settings page - no deleting required)
- CRUD Articles
- CR\*D Comments on articles (no updating required)
- GET and display paginated lists of articles
- Favorite articles
- Follow other users
**The general page breakdown looks like this:**
- Home page (URL: /)
- List of tags
- List of articles pulled from either Feed, Global, or by Tag
- Pagination for list of articles
- Sign in/Sign up pages (URL: /user/login, /user/register)
- Use JWT (store the token in localStorage)
- Settings page (URL: /user/settings )
- Editor page to create/edit articles (URL: /editor/new, /editor/article-slug-here)
- Article page (URL: /article/article-slug-here)
- Delete article button (only shown to article's author)
- Render markdown from server client side
- Comments section at bottom of page
- Delete comment button (only shown to comment's author)
- Profile page (URL: /profile/username-here, /profile/username-here?favorite=true)
- Show basic user info
- List of articles populated from author's created articles or author's favorited articles
[](https://thinkster.io)