github.com/bitcubate/cryptojournal@v1.2.5-0.20171102134152-f578b3d788ab/README.md (about)

     1  # Crypto Journal
     2  A responsive news website for links about the Cryptocurrency and Blockchain World, written in Go. You can see a this website in action at this link:
     3  
     4  [http://cryptojournal.cf](http://cryptojournal.cf)
     5  
     6  ## Gettting Started
     7  
     8  The app requires postgresql just now to bootstrap locally (not Mysql). So make sure you have psql installed. The bootstrap process will create a database and settings for you, but you'll need to promote the first user to admin in order to use the site locally.
     9  
    10  Go get this app:
    11  
    12      go get -u github.com/bitcubate/cryptojournal
    13  
    14  Then to build and run the server locally, as you'd expect:
    15  
    16      go run server.go
    17  
    18  or get the fragmenta command line tool (for things like migrations, deploy etc) and run it with that:
    19  
    20      go get -u github.com/fragmenta/fragmenta
    21      fragmenta server
    22  
    23  
    24  
    25  ## App Structure
    26  
    27  #### server.go
    28  This is the entry point main() for the application. It includes packages within src and starts a server. 
    29  
    30  #### The src folder
    31  This holds the website assets, actions and views - the meat of the app. 
    32  
    33  #### The src/app folder
    34  This contains general app files, resources like pages or users should go in a separate pkg.
    35  
    36  #### The src/users folder
    37  This contains files related to users on the website.
    38  
    39  #### The src/stories folder
    40  This contains files related to stories on the website.
    41  
    42  #### The src/comments folder
    43  This contains files related to comments on the website.
    44  
    45  #### The src/lib folder
    46  lib is used to store utility packages which can be used by several parts of the app.
    47  
    48  #### The src/lib/templates folder
    49  Templates for generating new resources are stored in here and used by fragmenta generate to generate a new resource package, containing assets, code and views for the resource.