Skip to content

Commit

Permalink
Merge pull request #1 from pullflow/doc/update-readme
Browse files Browse the repository at this point in the history
Doc: Add development steps in readme
  • Loading branch information
hassan-pullflow authored Oct 20, 2023
2 parents 2dfa578 + 69d33f3 commit a5ede64
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,26 @@ This extension is an open-source project created by [Pullflow Inc](https://githu

This is just the beginning of Pullflow's VS Code Slack integration, and we are eager to make improvements based on your feedback. Please don't hesitate to share your thoughts with us through [GitHub issues](https://github.com/pullflow/vscode-pullflow/issues) or on Twitter [@pullflow](https://twitter.com/pullflow).

#### **Development Guidelines**

1. Set up Pullflow account and connect your GitHub and Slack accounts.
2. Clone the repository.
3. Create `.env` file in the root directory and add the following environment variables:

```
SESSIONS_SECRET_KEY=(string) # any 32 characters key for session encryption
PULLFLOW_APP_URL="https://app.pullflow.com"
CLIENT_IDENTIFIER="com.pullflow.vscode"
```
4. Install node modules with `yarn install`.
5. Run extension with `yarn watch`.
6. Enter `cmd/ctrl+shift+D` to open debug panel and run extension in debug mode.
7. Run tests with `yarn test`.
8. Run `yarn lint` to check for linter errors.
9. Run `vsce package` to generate vsix file for extension.
10. Run `code --install-extension pullflow-{version}.vsix` to install extension locally.


## **License**

[MIT](https://github.com/pullflow/vscode-pullflow/blob/main/LICENSE)
Expand Down

0 comments on commit a5ede64

Please sign in to comment.