Skip to content

Nitrogen Web Framework for Erlang (now with websockets!)

License

Notifications You must be signed in to change notification settings

jbcorwin/nitrogen

 
 

Repository files navigation

Nitrogen Web Framework for Erlang

Nitrogen is an Erlang-based web framework that allows you to develop infinitely scaleable, Ajax-rich web applications using a pure Erlang technology stack.

See the Nitrogen Project website for additional information.

Upgrading from Nitrogen 2 to Nitrogen 3?

If you are using a Nitrogen 2 structured project, run the following two commands from the root of your Nitrogen 2-based project.

WARNING: Make sure you commit to version control before running this - it will change your working directory heavily

WARNING 2: Running scripts directly from the internet is dumb. Review the code of this script before you run it. But if you really want to do it this way, here you go.

curl -o https://raw.githubusercontent.com/nitrogen/nitrogen/rebar3/scripts/upgrade_to_nitrogen3.sh
bash upgrade_to_nitrogen3.sh

The first line downloads the upgrade script to your local project directory

The second line runs that script

Getting Started

Follow the tutorial at http://nitrogenproject.com/doc/tutorial.html

Building Nitrogen on Linux and OSX

The Getting Started guide covers this.

Building Nitrogen on FreeBSD

Install Erlang from

Make sure you have gmake installed, and use gmake instead of make

Example:

$ gmake rel_cowboy

Building Nitrogen on Windows

Instructions for building on windows can be found in rel/overlay/win

Upgrading from Rebar2 to Rebar3?

If you have a Nitrogen project generated by the make slim_X or make rel_X commands, run this from the root of your project to convert that project to rebar3:

curl -s https://raw.githubusercontent.com/nitrogen/nitrogen/rebar3/scripts/convert_to_rebar3.sh | bash

Concerned about running scripts directly from the internet?

You can download the script directly, or you can manually make the changes.

The rebar2-to-rebar3 conversion script can be found here

Want to contribute?

nitrogen_core is where you would find the vast majority of Nitrogen's codebase, should you wish to contribute or make changes.

Read our contribution guidelines to get started contributing to Nitrogen! (they're not strict, just recommendations)

About

Nitrogen Web Framework for Erlang (now with websockets!)

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Erlang 47.0%
  • Shell 16.9%
  • Perl 14.9%
  • Makefile 13.8%
  • Emacs Lisp 3.8%
  • HTML 1.6%
  • Other 2.0%