Giter Club home page Giter Club logo

icnelia's Introduction

==== icnelia ====

icnelia: is a word in nahuatl language that means "help"

Helper for compile, clean and create run scripts for your erlang OTP application

===== how to start =====

Clone icnelia repository from github:

$ git clone https://github.com/jorgegarrido/icnelia.git

Move into icnelia directory: $ cd icnelia and build the project and script: ./buiicn, now you can use the icnelia script in your Erlang OTP Applications.

===== how to use =====

Just place the icnelia script into your main directory of your application to compile use ./icnelia compile and compiles all the code in src directory, also set the compiled files (.beam) under ebin directory, to clean use ./icnelia clean and cleans all the compiled code in ebin directory.

To create a run script use ./icnelia runner and creates a run script to start your application (only start and load an erlang shell).

To create a run daemon script use ./icnelia runner daemon and creates a run script to start your application as daemon

===== icnelia.config =====

app_deps: here you can define the paths to ebin deps, for example:

{app_deps, [{"MY_DEP", "my_dep/ebin"}]}.

where "MY_DEP" is the name that the run script use to recongnize the path to your dep, and "my_dep/ebin" is the path to ebin for the dependence

pipes_dir: here you can define the path to your pipes directory, it is used when you want to run your application as daemon, for example:

    {pipes_dir, "/usr/local/My_Pipes/"}.	    
    NOTE: YOU MUST CREATE THE PIPES DIRECTORY MANUALLY

logs_dir: here you can define the path to logs used by your application, when it is running as daemon, for example:

   {logs_dir, "/usr/local/My_Logs/"}.
   NOTE: YOU MUST CREATE THE LOGS DIRECTORY MANUALLY

erl_opts: here you can set the options to compile the source code, the options are all supported by erlang version running, for example:

   {erl_opts, [debug_info]}.

===== LICENSE =====

see LICENSE.txt for more info

icnelia's People

Stargazers

 avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.