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

chore: update local development setup and docs #245

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
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
13 changes: 1 addition & 12 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -1,15 +1,4 @@
default_stages:
[
commit,
merge-commit,
push,
prepare-commit-msg,
post-checkout,
post-commit,
post-merge,
post-rewrite,
manual,
]
default_stages: [commit]
exclude: >
(?x)^(
test\.tsx\.snap$
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ The list of what it is tracking can be found in `.gitattributes`, currently `ter
To add to the tracked list, use
`git lfs track <>` where <> could be `"*.someFileExtension"`, `path/to/dir/**` for an entire directory.

Add environment variables to `/app/.env`

## Tooling initialization

### asdf
Expand Down
1 change: 1 addition & 0 deletions app/.eslintignore
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
dist/
**/.git/*
4 changes: 4 additions & 0 deletions app/.prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,7 @@ schema/schema.graphql
coverage
../chart/**/templates/**/*.yaml
../.github/ISSUE_TEMPLATE/
**/.git
**/.svn
**/.hg
**/node_modules
8 changes: 5 additions & 3 deletions app/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,17 +17,19 @@ From the app root folder (the folder relative to the package.json file -$ cd app
1. Install dependencies:

```sh
npm install
yarn
```

2. Create an .env file in app root folder (see sample EOF)
2. Create an .env file in app root folder (see 1Password)

3. Start the dev server:

```sh
npm run dev
yarn dev
```

4. Open [http://localhost:3000](http://localhost:3000) and Sign in with Google using the test credentials (see 1Password). You may need to open a private browsing session to avoid trying to sign in with your current google account

Next.js 13 introduced a new file-system based router which works in a new directory named app.

[app routes](https://beta.nextjs.org/docs/routing/fundamentals#the-app-directory) can be accessed on [http://localhost:3000](http://localhost:3000).
Expand Down
Loading