Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update readme.md and add some script #108

Merged
merged 4 commits into from
Jul 1, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
![Stack Logo](/assets/logo.png)

<h3 align="center">
<a href="https://docs.stack-auth.com">📘 Documentation</a>
| <a href="https://stack-auth.com/">☁️ Hosted Version</a>
| <a href="https://demo.stack-auth.com/">✨ Demo</a>
| <a href="https://discord.stack-auth.com">Discord</a>
<a href="https://docs.stack-auth.com">📘 Documentation</a>
| <a href="https://stack-auth.com/">☁️ Hosted Version</a>
| <a href="https://demo.stack-auth.com/">✨ Demo</a>
| <a href="https://discord.stack-auth.com">Discord</a>
</h4>

## 💬 What is Stack?
Expand Down Expand Up @@ -78,28 +78,28 @@ Please read the [contribution guidelines](CONTRIBUTING.md) before contributing.

### Setup

Pre-populated .env files for the setup below are available and used by default in `.env.development` in each of the packages, but you can choose to create your own `.env.local` files instead.
Pre-populated .env files for the setup below are available and used by default in `.env.development` in each of the packages. You should copy all the `.env.development` files to `.env.local` in the respective packages for local development.

In a terminal, start the dependencies (Postgres and Inbucket) as Docker containers:

```sh
docker compose -f dependencies.compose.yaml up
```

Then:
Then open a new terminal:

```sh
pnpm install

# Run build to build everything once
pnpm run build

# initialize the database and seed it with some data
pnpm prisma seed

# Run code generation (repeat this after eg. changing the Prisma schema). This is part of the build script, but faster
pnpm run codegen

# Push the most recent Prisma schema to the database
pnpm run prisma db push

# Start the dev server
pnpm run dev
```
Expand Down
Loading