github.com/vulppine/fotoDen@v0.3.0/README.md (about)

     1  fotoDen
     2  =======
     3  
     4  *A statically structured, front-end dynamic photo gallery*
     5  
     6  [Wiki](https://github.com/vulppine/fotoDen/wiki)
     7  
     8  Using
     9  -----
    10  
    11  fotoDen is designed so that it can be used independent of any separate tool, but
    12  it works well if you have the fotoDen tool in order to create folders and albums
    13  that are directly accessable by fotoDen's front end.
    14  
    15  Using the pre-built fotoDen tool from release is as simple as initializing a
    16  website (with an optional theme - one is already included!)
    17  
    18  ``` sh
    19  fotoDen init -i site --name "[ your website name here ]" my_website/
    20  ```
    21  
    22  From there, you can start generating folders and albums as you wish:
    23  
    24  ``` sh
    25  fotoDen create folder --name "[ your folder name here ]" my_website/my_folder/
    26  fotoDen create album --name "[ your album name here ]" my/images/are/here my_website/my_folder/my_album
    27  ```
    28  
    29  Run the fotoDen command for more options. (More detailed information and
    30  commands will be added soon, including use of the build system!)
    31  
    32  ### Warning
    33  
    34  fotoDen is still in its *very early* stages, at v0 - everything and anything is
    35  subject to change. While I'll attempt to keep its base structure stable,
    36  commands and folder metadata are *subject to change in drastic ways*. Upgrade
    37  paths will be offered for fotoDen version transitions that up the minor version
    38  number (v0 . *y* . 0), so that version transitions with new changes are more
    39  easier.
    40  
    41  Installing
    42  ----------
    43  
    44  You will require the latest version of
    45  [libvips](https://github.com/libvips/libvips) in order to use fotoDen.
    46  
    47  You can either install from an existing build [which includes fotoDen.js md5
    48  checksums for both the minified version, and the JS file that came with its
    49  release], or you can install the tool alone by running `go install
    50  github.com/vulppine/fotoDen`.
    51  
    52  Building
    53  --------
    54  
    55  You will require the latest version of
    56  [libvips](https://github.com/libvips/libvips), [terser](https://terser.org), and
    57  [Go](https://golang.org) in order to build fotoDen from source.
    58  
    59  1. Clone the git repository into a directory of your choice
    60  2. Run `make all` in the resulting folder
    61  3. fotoDen will be located in the **build/** folder in the same directory.
    62  
    63  Contributing
    64  ------------
    65  
    66  If you want to contribute, I encourage you to fork and help develop fotoDen!
    67  Note that fotoDen uses [Standard JS](https://github.com/standard/standard) for
    68  its JavaScript style.
    69  
    70  A testing script is included in the root of the repository - run it in your
    71  local environment to generate a test website. Generating the container will
    72  require Docker.
    73  
    74  Dependencies
    75  ------------
    76  
    77  fotoDen relies on a few important dependencies (both front and back), so here
    78  are links to the dependencies that fotoDen uses! License information for
    79  included source code can be found in their respective locations.
    80  
    81  | Dependency         | Author                 | License    |
    82  |--------------------|------------------------|------------|
    83  | [bimg]             | Tomas Aparicio         | MIT        |
    84  | [Cobra]            | spf13                  | Apache 2.0 |
    85  | [Bootstrap]        | Twitter/Bootstrap Team | MIT        |
    86  | [justified-layout] | Flickr/SmugMug         | MIT        |
    87  | [exif-js]          | Jacob Seidelin         | MIT        |
    88  | [go-yaml]          | go-yaml team           | Apache 2.0 |
    89  | [Goldmark]         | goldmark team          | MIT        |
    90  
    91  [bimg]: https://github.com/h2non/bimg
    92  [Cobra]: https://github.com/spf13/cobra
    93  [Bootstrap]: https://github.com/twbs/bootstrap
    94  [justified-layout]: https://github.com/flickr/justified-layout
    95  [exif-js]: https://github.com/exif-js/exif-js
    96  [go-yaml]: https://github.com/go-yaml/yaml
    97  [Goldmark]: https://github.com/yuin/goldmark
    98  
    99  
   100  Copyright
   101  ---------
   102  
   103  fotoDen is copyright 2021 Flipp Syder under the MIT License (see LICENSE for
   104  more information)
   105  
   106  All test images licensed are under the
   107  [CC-BY-NC-SA](https://creativecommons.org/licenses/by-nc-sa/4.0/)