Skip to content

Commit 8bce868

Browse files
authoredNov 14, 2019
Update CONTRIBUTING.md
1 parent 9b68035 commit 8bce868

File tree

1 file changed

+7
-16
lines changed

1 file changed

+7
-16
lines changed
 

‎CONTRIBUTING.md

+7-16
Original file line numberDiff line numberDiff line change
@@ -22,20 +22,10 @@ npm run dev # runs backend + frontend, both reloading on changes
2222
```
2323

2424
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).
2626

27+
To create a production build, run `npm build`.
2728

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-
```
3929

4030
### Testing
4131

@@ -58,9 +48,8 @@ We use Eslint for linting. The linting tests are cached with the `--cache` optio
5848

5949
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))
6050

61-
- client config: [./src/client/.eslintrc.js](./src/client/.eslintrc.js)
62-
- server config: [./src/server/.eslintrc.js](./src/server/.eslintrc.js)
63-
- general config: [./.eslintrc.js](./.eslintrc.js)
51+
- client-specific config: [./src/client/.eslintrc.js](./src/client/.eslintrc.js)
52+
- common (shared between server+client) config: [./.eslintrc.js](./.eslintrc.js)
6453

6554
```bash
6655
npm run check:lint # runs the linter
@@ -71,7 +60,8 @@ npm run check:lint:fix # runs the linter with autofix
7160

7261
- `/__mocks__` - mocks for testing
7362
- `/__snapshots__` - jest snapshots for frontend testing
74-
- `/.vscode` - contains vscode workspace settings, recommended plugins, and launch debug config
63+
- `/.vscode` - vscode workspace settings, recommended plugins, and launch debug config
64+
- `/scripts` - runnable scripts to do certain tasks (install, populate DB, make an organizer, make a volunteer, etc.)
7565
- `/src`
7666
- `/client`
7767
- `/assets` - static assets
@@ -87,6 +77,7 @@ npm run check:lint:fix # runs the linter with autofix
8777
- `index.ts` - main Express API server and Apollo Server
8878
- `models.ts` - graphql models
8979
- `resolvers.ts` - graphql resolvers
80+
- `/types` - misc. type declaration files
9081
- `// lots of config files here`
9182

9283
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

Comments
 (0)
Please sign in to comment.