From 20dedca9b64149d2b815a99a68620ebf216d4c8c Mon Sep 17 00:00:00 2001 From: Mickael Kerjean Date: Thu, 6 Feb 2020 12:52:13 +1100 Subject: [PATCH] doc (contributing): update build instructions --- CONTRIBUTING.md | 54 ++++++++++--------------------------------------- 1 file changed, 11 insertions(+), 43 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ba6592db..75ce7a94 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,67 +6,35 @@ Thanks for taking the time to join our community and start contributing. This gu ### Before you submit a pull request -For anything else than a typo or an obvious bug fix, please raise an issue to discuss your proposal before submitting any code. +For anything else than a typo or a bug fix, please raise an issue to discuss your proposal before submitting any code. ### License for contributions As the copyright owner, you agree to license your contributions under an irrevocable MIT license. -## Building from source +### Building from source -### Prerequisites -- Git -- Make -- Node -- Go +*Prerequisites*: Git, Make, Node, Go -### Download the source ``` -export $GOPATH=/wherever/you/want -cd $GOPATH -mkdir -p github.com/mickael-kerjean/ && cd github.com/mickael-kerjean/ +# Download the source git clone https://github.com/mickael-kerjean/filestash cd filestash -``` -### Install dependencies -``` -# frontend dependencies -npm install +# Install dependencies +npm install # frontend dependencies +make build_init # install the required static libraries +mkdir -p ./dist/data/state/ +cp -R config ./dist/data/state/ -# backend dependencies -go get ./server/... -make build_init # beware this will install the required C headers under /usr/local/include/ -``` - -### Building -*Frontend*: -``` -# Production build: +# Create the build make build_frontend - -# Development build: -npm run dev -``` - -*Backend*: -``` make build_backend -``` -*Run*: -``` +# Run the program ./dist/filestash ``` -*Clear*: -``` -# clear the frontend -rm -rf ./dist/data/public/ -# clear the entire build -rm -rf ./dist -``` - ### Tests Our tests aren't open source. This comes as an attempt to restrict opportunistic forks (see [1](https://news.ycombinator.com/item?id=17006902#17009852) and [2](https://www.reddit.com/r/selfhosted/comments/a54axs/annoucing_jellyfin_a_free_software_fork_of_emby/ebk92iu/?utm_source=share&utm_medium=web2x)) from creating a stable release without serious commitment and splitting the community in pieces while I'm on holidays. Also the project welcome serious and willing maintainers.