Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding instruction for running redis #7434

Merged

Conversation

guillim
Copy link
Contributor

@guillim guillim commented Oct 4, 2024

fixes #7433

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR Summary

This PR enhances the local setup documentation by adding instructions for starting the Redis server, a crucial step for optimal performance of the Twenty application.

  • Added step-by-step instructions for starting Redis server on Linux, Mac OS, and Windows (WSL) in packages/twenty-website/src/content/developers/local-setup.mdx
  • Inserted the Redis server startup step before the database setup and application launch steps
  • Improved overall clarity of the setup process by explicitly mentioning the need for a running Redis cache

1 file(s) reviewed, 1 comment(s)
Edit PR Review Bot Settings

Comment on lines 201 to 203
```bash
redis-server.exe
```
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

logic: Windows Redis start command is incorrect. Redis on Windows is not officially supported and requires different setup.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To be honest, I don't have windows. So it googled a way to run redis on windows but it may be wrong !

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@guillim Twenty doesn't run directly on Windows but on WSL, please fix this accordingly to WSL setup

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point @BOHEUS thanks!

@FelixMalfait FelixMalfait force-pushed the guillim-documentation-improvement branch from 12849b3 to d01ddeb Compare October 4, 2024 17:07
Copy link
Member

@FelixMalfait FelixMalfait left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your first contribution 🙌

@FelixMalfait FelixMalfait merged commit 744304e into twentyhq:main Oct 4, 2024
2 of 3 checks passed
@guillim guillim deleted the guillim-documentation-improvement branch October 9, 2024 10:21
harshit078 pushed a commit to harshit078/twenty that referenced this pull request Oct 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Readme improvement
3 participants