https://github.com/funkywork/nightmare

A set of components that fit, a priori, relatively well with the web framework (OCaml) Dream to try to build, at best, and quickly, dynamic web applications.
https://github.com/funkywork/nightmare

Last synced: 3 months ago
JSON representation

A set of components that fit, a priori, relatively well with the web framework (OCaml) Dream to try to build, at best, and quickly, dynamic web applications.

• Host: GitHub
• URL: https://github.com/funkywork/nightmare
• Owner: funkywork
• License: mit
• Created: 2022-08-30T14:02:21.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-01-29T11:46:40.000Z (10 months ago)
• Last Synced: 2024-05-31T10:41:05.397Z (6 months ago)
• Language: OCaml
• Size: 277 KB
• Stars: 46
• Watchers: 9
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Nightmare

> **Warning** _Nightmare_ is still _Work In Progress_.

A set of components that fit, in theory, relatively well with the web framework

([OCaml](https://ocaml.org)) [Dream](https://aantron.github.io/dream/) to try to

build quickly and as best as possible dynamic web applications.

**Nightmare** was very much inspired by the development of

[Muhokama](https://github.com/xvw/muhokama/), a forum written in

[OCaml](https://ocaml.org) which had many of its components imported

directly into **Nightmare**. The set of ideas implemented in this "adhoc

framework" comes from different sources of inspiration which we will try to list

meticulously in an appropriate section.

Even though the framework is intended to be as agnostic as possible, it has been

designed to blend in naturally with [Dream](https://aantron.github.io/dream/),

hence the library's name.

## Setting up the development environment

Setting up a development environment is quite straightforward. We recommend setting

up a local switch to collect dependencies locally. Here are the commands to enter

to initialize the environment:

```shellsession

opam update

opam switch create . ocaml-base-compiler.5.0.0 --deps-only -y

eval $(opam env)

```

After initializing the switch, you can collect the development and project

dependencies using `make`:

```shellsession

make dev-deps

make deps

```

Now you should be able to easily start contributing to **Nightmare**.

> **Note** If you are not using [GNU/Make](https://www.gnu.org/software/make/)

> (or equivalent), you can refer to the [Makefile](Makefile) and observe the

> `dev-deps` and `deps` rules to get the commands to run.