https://github.com/brainrake/fithub

https://github.com/brainrake/fithub

Last synced: 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/brainrake/fithub
• Owner: brainrake
• Created: 2014-12-01T20:23:50.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2014-12-06T11:52:32.000Z (over 11 years ago)
• Last Synced: 2025-06-21T20:03:19.530Z (10 months ago)
• Language: Makefile
• Size: 145 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README

Awesome Lists containing this project

README

          

Instructions

============

This project is (initially) generated by eliom-distillery as the basic

project "fithub".

Generally, you can compile it and run ocsigenserver on it by

  $ make test.byte (or test.opt)

See below for other useful targets for make.

Generated files

---------------

The following files in this directory have been generated by

eliom-distillery:

 - fithub.eliom

   This is your initial source file.

   All Eliom files (*.eliom, *.eliomi) in this directory are

   automatically considered.  To add a .ml/.mli file to your project,

   append it to the variable SERVER_FILES or CLIENT_FILES.

 - static/

   The content of this folder is statically served. Put your CSS or

   additional JavaScript files here!

 - Makefile.options

   Configure your project here!

 - fithub.conf.in

   This file is a template for the configuration file for

   ocsigenserver. You will rarely have to edit itself - it takes its

   variables from the Makefile.options. This way, the installation

   rules and the configuration files are synchronized with respect to

   the different folders.

 - Makefile

   This contains all rules necessary to build, test, and run your

   Eliom application. You better don't touch it ;) See below for the

   relevant targets.

 - local/

   This directory is the target of the temporary installation of

   your application, to test locally before doing a system-wide

   installation in /. Do not put anything manually here.

 - README

   Not completely describable here.

Makefile targets

----------------

Here's some help on how to work with this basic distillery project:

 - Test your application by compiling it and running ocsigenserver locally

     $ make test.byte (or test.opt)

 - Compile it only

     $ make all (or byte or opt)

 - Deploy your project on your system

     $ sudo make install (or install.byte or install.opt)

 - Run the server on the deployed project

     $ sudo make run.byte (or run.opt)

   If WWWUSER in the Makefile.options is you, you don't need the

   `sudo'. If Eliom isn't installed globally, however, you need to

   re-export some environment variables to make this work:

     $ sudo PATH=$PATH OCAMLPATH=$OCAMLPATH LD_LIBRARY_PATH=$LD_LIBRARY_PATH make run.byte/run.opt

 - If you need a findlib package in your project, add it to the

   variables SERVER_PACKAGES and/or CLIENT_PACKAGES. The configuration

   file will be automatically updated.