git.iko.soy/obelisk
on master help sign in
breif deployment description added
42a27dchsloan
README.md+22
compare with master
unifiedsplit
@@ -33,10 +33,32 @@ Point your web browser at [localhost:8000](localhost:8000) and everything should
33Feel free to edit the frontend and backend directories as you see fit.
33Feel free to edit the frontend and backend directories as you see fit.
34
34
35--------------------------DEVELOPER TOOLS----------------------------------------
35--------------------------DEVELOPER TOOLS----------------------------------------
36+
36To increase developer productivity it is highly recommended to make use of the
37To increase developer productivity it is highly recommended to make use of the
37`ghcid-frontend` and `ghcid-backend` scripts. This will open a live repl that
38`ghcid-frontend` and `ghcid-backend` scripts. This will open a live repl that
38will compile and refresh itself showing you the latest possible syntax or type errors
39will compile and refresh itself showing you the latest possible syntax or type errors
39as well as any other ghc warnings whenever files within their respective directories
40as well as any other ghc warnings whenever files within their respective directories
40are saved and updated.
41are saved and updated.
41
42
43+-----------------------DEPLOYMENT------------------------------------------------
44+
45+From Nix to NixOS:
46+When you feel your repository is ready to be deployed, feel free to utilize some scripts to aid in the process.
47+
48+Assuming you have taken the neccessary steps in setting up your staging/production server: TODO Elaborate on this setup as well.
49+
50+From within the root of your obelisk project directory, use the script and syntax provided below:
51+
52+```bash
53+./set-deploy [DESTINATION DIR] [PRIVATE KEY FILE]
54+```
55+
56+This script will create a `deploy` directory within the directory you've specified within the first arguement to the script. To start deployment to your NixOS server, `cd` into the `deploy/src` directory and use the following script and syntax provided below:
57+
58+```bash
59+./obelisk/deploy [yourServer.org] .. --arg ssl true
60+```
61+
62+-------------------------------------------------------------------------------
63+
42Thank you for using Obelisk.
64Thank you for using Obelisk.