https://github.com/blitz-js/blitz-realworld-example
https://github.com/blitz-js/blitz-realworld-example
Last synced: 12 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/blitz-js/blitz-realworld-example
- Owner: blitz-js
- Created: 2021-11-05T21:33:38.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-11-22T04:54:58.000Z (over 4 years ago)
- Last Synced: 2025-06-10T06:38:39.795Z (about 1 year ago)
- Language: TypeScript
- Size: 59.6 KB
- Stars: 4
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Blitz RealWorld
[React](https://reactjs.org) + [NextJS](https://nextjs.org) + [Prisma](https://www.prisma.io)
A FullStack [RealWorld 1.0 Starter App](https://codebase.show/projects/realworld?category=fullstack)
## Set Up Your Computer
You need Node.js 12 or newer. You can verify this by running `node -v` in your terminal. If you don't have Node or need a newer version, we recommend using a node version manager like [fnm](https://github.com/Schniz/fnm) so you can change node versions for each project.
## Install Blitz
Run `yarn global add blitz`
You'll only need to run the above the first time you install blitz.
## Create a New App
Choose defaults: Typescript, Full, Yarn, React Final Form...
`blitz new myAppName`
`cd myAppName`
Install Tailwind CSS (Learn more about [Blitz recipes](https://blitzjs.com/docs/using-recipes))
`blitz install tailwind`
`blitz dev`
View your brand new app at [http://localhost:3000](http://localhost:3000)
If you delete your app folder, use a new terminal window when running `blitz new myAppName` to avoid conflicts in your virutal .env
## Add RealWorld model to your app
**1. Minimum Tables (to be similar to other RealWorld samples) - currently broken**
To run only the simple RealWorld 1.0 schema, copy and rename realworld.prisma to db/schema.prisma.
**TypeError** Cannot read property 'findFirst' of undefined
Use schema.prisma below until error above resolved.
**2. All the Tables - the following works**
To create a RealWorld 2.0 site, copy schema.prisma into the db folder. This will provide:
**RealWorld tables:**
User, Article, Content, Tag
**Blitz tables:**
Session, Token, Project
Additional tables to add:
**Blitz survey tables** (from the [Blitz tutorial](https://blitzjs.com/docs/tutorial)):
Question, Choice
**Civic Tech tables** (to be determined)
Org, Place, Event, Service, Item
Generate the model by running:
`blitz generate all project name:string`
Select Yes to run Prisma migrate dev to update your database
Enter a name for the new migration, then restart the server
`Ctrl + c`
`blitz dev`
Then go to [http://localhost:3000/projects](http://localhost:3000/projects)
## Pages: Article, Editor, Profile, User
The "pages" folder originates from the [NextJS Realworld demo](https://github.com/cirosantilli/node-express-sequelize-nextjs-realworld-example-app/tree/next/pages). We need a process for moving it into the existing pages folder within [myAppName].
---
[GitHub](https://github.com/blitz-js/blitz-realworld-example) - [RealWorld 2.0](https://neighborhood.org/planning/#display=planning.md)