Skip to content

Commit

Permalink
chore: improve contribution docs (#184)
Browse files Browse the repository at this point in the history
  • Loading branch information
avitorio authored Feb 9, 2024
1 parent 670cada commit f052afa
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 17 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ There are a few particularities to how Outstatic works. Since most editor action
```
1. Start developing and watch for code changes:
```
pnpm dev --filter outstatic-dev-blog --filter outstatic
pnpm dev
```
The above command will tell turborepo to only load the `outstatic` library and the `outstatic-dev-blog` project.
1. When your changes are finished, commit them to the branch:
Expand Down
23 changes: 8 additions & 15 deletions apps/dev/.env.local.example
Original file line number Diff line number Diff line change
@@ -1,24 +1,17 @@
NEXT_PUBLIC_APP_URL=http://localhost:3000

# The `/apps/dev/` folder is a Next.js app that is used to develop and test Outstatic.
# REQUIRED Environment variables
OST_GITHUB_ID=YOUR_GITHUB_OAUTH_ID
OST_GITHUB_SECRET=YOUR_GITHUB_OAUTH_SECRET
OST_TOKEN_SECRET=A_32CHAR_RANDOM_STRING_FOR_YOUR_TOKEN_SECRET
OST_REPO_SLUG=THE_REPOSITORY_SLUG
# If empty AND on Vercel, your OST_REPO_SLUG defaults to VERCEL_GIT_REPO_SLUG
OST_REPO_SLUG=outstatic
OST_REPO_BRANCH=main
OST_CONTENT_PATH=outstatic/content
OST_MONOREPO_PATH=apps/dev

# OPTIONAL Environment variables

# If empty, OST_REPO_BRANCH defaults to main
# OST_REPO_BRANCH=THE_REPOSITORY_BRANCH
# For more information visit: https://outstatic.com/docs/environment-variables

# # If empty, OST_REPO_OWNER the GitHub username of the logged in account will be used
# OST_REPO_OWNER=THE_REPO_OWNER

# # OST_CONTENT_PATH is the path of where content is saved, if empty it defaults to outstatic/content
# OST_CONTENT_PATH=outstatic/content

# # Specify monorepo folder of your Outstatic content
# OST_MONOREPO_PATH=apps/web

# For more information visit: https://outstatic.com/docs/environment-variables
# If you want to deploy your own instance of Outstatic visit https://outstatic.com/docs/getting-started
# You can also download the repository and use the `/examples/blog` folder as a starting point for your own site.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
],
"scripts": {
"build": "turbo run build",
"dev": "turbo run dev",
"dev": "turbo run dev --filter=outstatic-dev-blog --filter=outstatic",
"lint": "turbo run lint",
"clean": "turbo run clean",
"format": "prettier --write",
Expand Down

0 comments on commit f052afa

Please sign in to comment.