Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sawirricardo/remix-realworld
Exemplary real world application built with Remix
https://github.com/sawirricardo/remix-realworld
express expressjs react reactjs realworld remix remix-run rest-api
Last synced: about 2 months ago
JSON representation
Exemplary real world application built with Remix
- Host: GitHub
- URL: https://github.com/sawirricardo/remix-realworld
- Owner: sawirricardo
- Created: 2022-06-20T11:48:05.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-06-21T04:55:16.000Z (about 2 years ago)
- Last Synced: 2024-05-09T08:35:27.468Z (4 months ago)
- Topics: express, expressjs, react, reactjs, realworld, remix, remix-run, rest-api
- Language: TypeScript
- Homepage: https://remix-realworld-production.up.railway.app/
- Size: 337 KB
- Stars: 48
- Watchers: 3
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-remix - Remix Example App
- awesome-remix - Remix Example App
README
# ![Remix Example App]()
> ### Remix 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://remix-realworld-production.up.railway.app/) [RealWorld](https://github.com/gothinkster/realworld)
## Getting started
You can view a live demo over at https://remix-realworld-production.up.railway.app/
To get the frontend running locally:
- Clone this repo
- `npm install` to install all req'd dependencies
- `npm run setup` to initialize the migration of the database. Currently it is setup for postgres, simply change the DATABASE_URL as you see fit.
- `npm run build` to build the server
- `npm run dev`
Local web server will use port 3000
## 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://redux.productionready.io/
**General functionality:**
- Authenticate users via NodeJS Session
- CRU\* users (sign up & settings page - no deleting required)
- CRUD Articles
- CR\*D Comments on articles (no updating required)
- 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: /#/login, /#/register )
- Use JWT (store the token in localStorage)
- Settings page (URL: /#/settings )
- Article page (URL: /#/articles/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: /#/@username, /#/@username/favorites )
- Show basic user info
- List of articles populated from author's created articles or author's favorited articles
[](https://thinkster.io)