https://github.com/addono/redwood-realworld-example-app
https://github.com/addono/redwood-realworld-example-app
Last synced: 7 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/addono/redwood-realworld-example-app
- Owner: Addono
- Created: 2023-02-23T14:19:15.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-04-03T16:17:13.000Z (about 3 years ago)
- Last Synced: 2024-12-27T00:27:26.565Z (over 1 year ago)
- Language: TypeScript
- Homepage: https://github.com/TristanWYL/redwood-realworld-example-app
- Size: 2.58 MB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Overview
This repository is created as part of [RealWorld](https://github.com/gothinkster/realworld) using [Redwood](https://redwoodjs.com/) which is an open-source, full-stack web framework.
To keep the consistency of UI, this repository simply use the [template](https://realworld-docs.netlify.app/docs/specs/frontend-specs/templates/) of RealWorld, and the css framework keeps the same with this template: BootStrap 4.
# How to run this repository
> **Prerequisites**
>
> - Redwood requires [Node.js](https://nodejs.org/en/) (>=14.19.x <=16.x) and [Yarn](https://yarnpkg.com/) (>=1.15)
> - Are you on Windows? For best results, follow [Windows development setup](https://redwoodjs.com/docs/how-to/windows-development-setup) guide
Start by installing dependencies:
```
yarn install
```
Then start the development server:
```
yarn redwood dev
```
Your browser should automatically open to http://localhost:8910.
# ToDo
- [ ] finish the unit/integration test
- [ ] fix the [potential issues](#potential-issues-to-be-fixed)
# Potential issues to be fixed
- [ ] query for user(s) is marked as @requireAuth which means only authenticated users can access the query. However, what if an authenticated user queries other users' personal info? Is this possible?
- [ ] When clicking on any 'favorite' button, it's supposed that only one http request is sent. However, the application sends four http requests. Some requests seem unnecessary.
- [ ] At the home page, when shrinking the width, the UI does not work as demanded.
- [ ] In a [commit](https://github.com/TristanWYL/redwood-realworld-example-app/commit/744fb6ee37ff4121d91b49e7f86e7077f608ee36), the GraphQL operation 'queryArticleBySlug' always gets a field 'followedByMe' as null.
# About Redwood
Redwood relies on the following techniques:
- [React](https://reactjs.org/)
A JavaScript library for building user interfaces.
- [GraphQL](https://graphql.org/)
GraphQL is a query language for APIs and a runtime for fulfilling those queries with your existing data. GraphQL provides a complete and understandable description of the data in your API, gives clients the power to ask for exactly what they need and nothing more, makes it easier to evolve APIs over time, and enables powerful developer tools.
- [Prisma](https://www.prisma.io/)
Redwood uses [Prisma](https://www.prisma.io/), a next-gen Node.js and TypeScript ORM, to talk to the database. Prisma's schema offers a declarative way of defining your app's data models. And Prisma [Migrate](https://www.prisma.io/migrate) uses that schema to make database migrations hassle-free:
```
yarn rw prisma migrate dev
```
- [Storybook](https://storybook.js.org/)
Redwood integrates Storybook so that you can work on design without worrying about data.
Mockup, build, and verify your React components, even in complete isolation from the backend:
```
yarn rw storybook
```
- [Jest](https://jestjs.io/)
Redwood fully integrates Jest with the front and the backends and makes it easy to keep your whole app covered by generating test files with all your components and services:
```
yarn rw test
```