https://github.com/nitrogen/nitrogen
Nitrogen Web Framework for Erlang (now with websockets!)
https://github.com/nitrogen/nitrogen
erlang javascript webframework websockets
Last synced: 8 months ago
JSON representation
Nitrogen Web Framework for Erlang (now with websockets!)
- Host: GitHub
- URL: https://github.com/nitrogen/nitrogen
- Owner: nitrogen
- License: mit
- Created: 2008-10-28T01:21:03.000Z (about 17 years ago)
- Default Branch: master
- Last Pushed: 2025-03-05T20:26:55.000Z (11 months ago)
- Last Synced: 2025-04-13T12:45:35.170Z (9 months ago)
- Topics: erlang, javascript, webframework, websockets
- Language: Erlang
- Homepage: http://nitrogenproject.com
- Size: 8.01 MB
- Stars: 960
- Watchers: 37
- Forks: 159
- Open Issues: 14
-
Metadata Files:
- Readme: README.markdown
- Changelog: CHANGELOG.markdown
- License: LICENSE
- Support: support/embed/add_rebar_deps.escript
Awesome Lists containing this project
- awesome-erlang - Nitrogen - Framework to build web applications (including front-end) in pure Erlang. (Web Frameworks)
README
# 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](http://nitrogenproject.com) 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
[this script's code](https://raw.githubusercontent.com/nitrogen/nitrogen/master/scripts/upgrade_to_nitrogen3.sh)
before you run it. But if you really want to do it this way, here you go.**
```bash
curl -o https://raw.githubusercontent.com/nitrogen/nitrogen/master/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](http://nitrogenproject.com/doc/tutorial.html)
## Building Nitrogen on Linux and OSX
The [Getting Started](http://nitrogenproject.com/doc/index.html#sec-3) guide covers this.
## Building Nitrogen on FreeBSD
Install Erlang
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](https://github.com/nitrogen/nitrogen/blob/master/rel/overlay/win/README.md)
## Want to contribute?
[nitrogen_core](https://github.com/nitrogen/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](https://github.com/nitrogen/nitrogen/blob/master/CONTRIB.markdown)
to get started contributing to Nitrogen! (they're not strict, just
recommendations)