You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: CONTRIBUTING.md
+7-16
Original file line number
Diff line number
Diff line change
@@ -22,20 +22,10 @@ npm run dev # runs backend + frontend, both reloading on changes
22
22
```
23
23
24
24
Now to go `localhost:8081` to see the page.
25
-
NOTE: you can also go to `localhost:8080/graphql` to see an interactive GraphQL IDE to try out queries and mutations.
25
+
NOTE: you can also go to `localhost:8080/graphql` to see an interactive GraphQL IDE to try out queries and mutations (disabled in production env by default).
26
26
27
+
To create a production build, run `npm build`.
27
28
28
-
### Useful GraphQL queries
29
-
30
-
This query will create a sponsor and associate with a company
31
-
```
32
-
mutation {
33
-
createSponsor(input: {
34
-
name: "name", email: "email", companyId: "insert company id here"
35
-
})
36
-
{id}
37
-
}
38
-
```
39
29
40
30
### Testing
41
31
@@ -58,9 +48,8 @@ We use Eslint for linting. The linting tests are cached with the `--cache` optio
58
48
59
49
NOTE: there are multiple eslint files. The rules are cascaded with the rule in the more specific directory taking priority (see [Eslint cascading hierarchy](https://eslint.org/docs/user-guide/configuring#configuration-cascading-and-hierarchy))
-`/scripts` - runnable scripts to do certain tasks (install, populate DB, make an organizer, make a volunteer, etc.)
75
65
-`/src`
76
66
-`/client`
77
67
-`/assets` - static assets
@@ -87,6 +77,7 @@ npm run check:lint:fix # runs the linter with autofix
87
77
-`index.ts` - main Express API server and Apollo Server
88
78
-`models.ts` - graphql models
89
79
-`resolvers.ts` - graphql resolvers
80
+
-`/types` - misc. type declaration files
90
81
-`// lots of config files here`
91
82
92
83
NOTE: We use [dotansimha/graphql-code-generator](https://github.com/dotansimha/graphql-code-generator) for automatic code generation. The mappings for schema models to db models are in [./codegen.json](./codegen.json).
0 commit comments