Skip to content

Commit

Permalink
improve readme a bit
Browse files Browse the repository at this point in the history
  • Loading branch information
kentcdodds committed Mar 16, 2022
1 parent 88cf640 commit 025208f
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 10 deletions.
20 changes: 16 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Remix Indie Stack

![The Remix Indie Stack](https://repository-images.githubusercontent.com/465928257/a241fa49-bd4d-485a-a2a5-5cb8e4ee0abf)

Learn more about [Remix Stacks](https://remix.run/stacks).

## What's in the stack
Expand All @@ -22,14 +24,24 @@ Not a fan of bits of the stack? Fork it, change it, and use `npx create-remix --

## Development

When you generated this project, it should have initialized the prisma database for you. With your sqlite database setup with tables for your data model via prisma, you're ready to start the dev server:
- Initial setup: _If you just generated this project, this step has been done for you._

```sh
npm run dev
```
```sh
npm run setup
```

- Start dev server:
```sh
npm run dev
```

This starts your app in development mode, rebuilding assets on file changes.

The database seed script creates a new user with some data you can use to get started:

- Email: `[email protected]`
- Password: `rachelrox`

### Relevant code:

This is a pretty simple note-taking app, but it's a good example of how you can build a full stack app with Prisma and Remix. The main functionality is creating users, logging in and out, and creating and deleting notes.
Expand Down
12 changes: 6 additions & 6 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,12 @@
"test:e2e:run": "cross-env PORT=8811 start-server-and-test start:mocks http://localhost:8811 'cypress run'",
"typecheck": "tsc -b && tsc -b cypress"
},
"prettier": {},
"eslintIgnore": [
"/node_modules",
"/build",
"/public/build"
],
"dependencies": {
"@node-rs/bcrypt": "^1.6.0",
"@prisma/client": "^3.11.0",
Expand Down Expand Up @@ -70,12 +76,6 @@
"engines": {
"node": ">=14"
},
"eslintIgnore": [
"/node_modules",
"/build",
"/public/build"
],
"prettier": {},
"prisma": {
"seed": "node --require esbuild-register prisma/seed.ts"
}
Expand Down

0 comments on commit 025208f

Please sign in to comment.