onionshare / onionshare

Securely and anonymously share files, host websites, and chat with friends using the Tor network
https://onionshare.org/
Other
6.31k stars 651 forks source link

Create a dev setup script #1922

Open SaptakS opened 2 months ago

SaptakS commented 2 months ago

Right now, one of the big blockers to contribution to OnionShare is setting up the entire project. Having a single script or command to set up the project locally from scratch may help people to get started quicker with contributing.

anastr0 commented 1 month ago

I would like to work on this issue.

I can start with a script for linux platforms for now and figure out win, macos scripts later. Document the installation process for the requirements (poetry, go, etc). As a later step, I can look into the viability to setup a dev container for this with some help.

SaptakS commented 1 month ago

@anastr0 great! The idea is to have a single script (it can be in python or bash or anything else) that anyone willing to contribute can run locally and the entire setup steps get executed. You can definitely start with writing a script for linux platform to begin with.

anastr0 commented 1 month ago

@SaptakS I have added a simple bash script here https://github.com/onionshare/onionshare/pull/1926 The script only works on linux. Let me know if I should add more info/ documentation.