This commit is contained in:
nooma
2023-08-19 21:42:25 +08:00
committed by Evis Chang
parent f4b8ff0348
commit 68cab7c665
11 changed files with 87 additions and 6 deletions

24
.github/bug_report.md vendored Normal file
View File

@@ -0,0 +1,24 @@
---
name: Bug Report
about: Create a report to help us improve
labels: bug
---
**Describe the bug**
A clear and concise description of what the bug is.
**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
**Expected behavior**
A clear and concise description of what you expected to happen.
**Screenshots**
If applicable, add screenshots to help explain your problem.
**Additional context**
Add any other context about the problem here.

14
.github/feature_request.md vendored Normal file
View File

@@ -0,0 +1,14 @@
---
name: Feature Request
about: Suggest an idea for this project
labels: enhancement
---
**Describe the feature you'd like**
A clear and concise description of what you want to happen.
**Describe alternatives you've considered**
A brief description of any alternative solutions or features you've considered.
**Additional context**
Add any other context or screenshots about the feature request here.

2
CONTRIBUTING.md Normal file
View File

@@ -0,0 +1,2 @@
# Opening an Issue
When initiating an issue, select a starting template: either Bug Report or Feature Improvement. If you're reporting a bug, ensure that you can demonstrate the bug through testing or a proof of concept. For suggesting a feature enhancement, name it with a clear problem description and verify that a similar request isn't already underway or completed. Be aware that not every issue might be considered necessary to fix, so be prepared to engage in discussions, answering any queries or comments others might have about the issue.

View File

@@ -1,6 +0,0 @@
1. check debuging extension is installed. maybe note it in README.md
2. debugging guide
- yarn relay debug
- attach to debugger process (relay and debug are separate processes)
3. the rest of
https://github.com/iverJisty/social-tw-website/pull/2#event-9972484000

0
docs/README.md Normal file
View File

Binary file not shown.

After

Width:  |  Height:  |  Size: 42 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 90 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 98 KiB

44
docs/local_development.md Normal file
View File

@@ -0,0 +1,44 @@
# Local Development
# Troubleshooting Tips
* pull latest changes from master and `yarn install` and `yarn build`
* install circom if you haven't already
* run following command and set up Twitter API Key. By default, it's a invalid API key.
```shell
cp packages/relay/.env_example packages/relay/.env
```
* you may start all daemons in one terminal window with `yarn start`, or start each daemon in a separate terminal window. If you start separately, it's easier to debug, since you don't need to restart hardhat node and redeploy contracts every time you change the code.
## Use VSCode Debugger to Debug Relay
With this configuration `.vscode/launch.json` in place, you can use VSCode debugger to debug relay.
```json
"version": "0.2.0",
"configurations": [
{
"type": "node",
"request": "attach",
"name": "Attach to backend process TS-Node",
"processId": "${command:PickProcess}",
"skipFiles": [
"<node_internals>/**"
]
},
],
```
![Select debug configuration](./images/AttachProcess.png)
Select debug configuration
![Attach to process](./images/AttachProcess2.png)
attach to process
![Set breakpoint](./images/SetBreakpoint.png)
and set breakpoint.
# Testing
In the root directory, run:
```shell
yarn run test
```
or run tests for a specific package:
```shell
yarn run test --scope @unirep-app/relay
```

3
docs/system_overview.md Normal file
View File

@@ -0,0 +1,3 @@
# System Overview
# Overview Diagram
[login flow](https://drive.google.com/file/d/1gP4fVwX9vjOVqCKJ2XYUMBYEn0ngH0cG/view?usp=sharing)

View File