Skip to content
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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,7 @@ apiPassword
releasePassword
.tmp
.idea
build
dist
.env
package-lock.json
1 change: 1 addition & 0 deletions .npmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
ignore-workspace-root-check=true
12 changes: 6 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ You will need to setup the `supertokens-core` in order to to run the `supertoken
### Prerequisites

- OS: Linux or macOS
- Nodejs & npm
- Nodejs & pnpm
- IDE: [VSCode](https://code.visualstudio.com/download)(recommended) or equivalent IDE

### Project Setup
Expand All @@ -30,15 +30,15 @@ You will need to setup the `supertokens-core` in order to to run the `supertoken
`supertokens-node` and `supertokens-root` should exist side by side within the same parent directory
3. `cd supertokens-node`
4. Install the project dependencies
`npm i -d`
`pnpm i -d`
5. Add git pre-commit hooks
`npm run set-up-hooks`
`pnpm run set-up-hooks`

## Modifying Code

1. Open the `supertokens-node` project in your IDE and you can start modifying the code
2. After modifying the code, build your project to implement your changes
`npm run build-pretty`
`pnpm run build-pretty`

## Testing

Expand All @@ -48,7 +48,7 @@ You will need to setup the `supertokens-core` in order to to run the `supertoken
3. Navigate to the `supertokens-node` repository
`cd ../supertokens-node/`
4. Run all tests
`INSTALL_PATH=../supertokens-root npm test`
`INSTALL_PATH=../supertokens-root pnpm test`
5. If all tests pass the output should be:
![node tests passing](https://github.com/supertokens/supertokens-logo/blob/master/images/supertokens-node-tests-passing.png)

Expand Down Expand Up @@ -86,5 +86,5 @@ Additional resources you might find useful:
This will generate the API docs in a folder called `docs`

```
npm run build-docs
pnpm run build-docs
```
3 changes: 0 additions & 3 deletions framework/awsLambda/index.d.ts

This file was deleted.

6 changes: 0 additions & 6 deletions framework/awsLambda/index.js

This file was deleted.

3 changes: 0 additions & 3 deletions framework/express/index.d.ts

This file was deleted.

6 changes: 0 additions & 6 deletions framework/express/index.js

This file was deleted.

3 changes: 0 additions & 3 deletions framework/fastify/index.d.ts

This file was deleted.

6 changes: 0 additions & 6 deletions framework/fastify/index.js

This file was deleted.

3 changes: 0 additions & 3 deletions framework/hapi/index.d.ts

This file was deleted.

6 changes: 0 additions & 6 deletions framework/hapi/index.js

This file was deleted.

3 changes: 0 additions & 3 deletions framework/koa/index.d.ts

This file was deleted.

6 changes: 0 additions & 6 deletions framework/koa/index.js

This file was deleted.

3 changes: 0 additions & 3 deletions framework/loopback/index.d.ts

This file was deleted.

6 changes: 0 additions & 6 deletions framework/loopback/index.js

This file was deleted.

3 changes: 0 additions & 3 deletions lib/build/constants.d.ts

This file was deleted.

19 changes: 0 additions & 19 deletions lib/build/constants.js

This file was deleted.

23 changes: 0 additions & 23 deletions lib/build/error.d.ts

This file was deleted.

30 changes: 0 additions & 30 deletions lib/build/error.js

This file was deleted.

91 changes: 0 additions & 91 deletions lib/build/framework/awsLambda/framework.d.ts

This file was deleted.

Loading