https://github.com/kennetpostigo/lwt-node
Reason Implementation of Node.js API ✨🏎🚀✨
https://github.com/kennetpostigo/lwt-node
lwt lwt-node native node reason reasonml
Last synced: 4 months ago
JSON representation
Reason Implementation of Node.js API ✨🏎🚀✨
- Host: GitHub
- URL: https://github.com/kennetpostigo/lwt-node
- Owner: kennetpostigo
- License: mit
- Created: 2017-07-09T03:09:09.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-03-13T14:03:00.000Z (about 7 years ago)
- Last Synced: 2025-01-13T16:55:30.704Z (4 months ago)
- Topics: lwt, lwt-node, native, node, reason, reasonml
- Language: OCaml
- Homepage: https://kennetpostigo.github.io/lwt-node/
- Size: 754 KB
- Stars: 220
- Watchers: 5
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Roadmap: ROADMAP.md
Awesome Lists containing this project
README
lwt-node, a [reason](https://github.com/facebook/reason) implemention of the [node.js](https://github.com/nodejs/node) API.
## Install
First you need to install [esy](https://github.com/esy/), Sandboxed and project based installations that share build artifacts and builds, for lightning fast installations and incremental builds:
```bash
yarn global add esy
# OR with npm
npm install --global esy
```
Then go ahead and add lwt-node to your project with esy:
```bash
esy add lwt-node
```
## Usage
See https://github.com/kennetpostigo/lwt-node-starter
## Documentation
See https://kennetpostigo.github.io/lwt-node
## Contributing
See [Contributing.md](https://github.com/kennetpostigo/lwt-node/blob/master/CONTRIBUTING.md)
Missing or yet to be implemented API's are documented with compile-time warnings, are noted in the documentation and are listed in [Future.md](https://github.com/kennetpostigo/lwt-node/blob/master/Future.md). If you'd like to help contribute, please open a pull-request, no code needed! We'll try to help steer you in the right direction!
**building**
1. Clone the project
2. Run `esy install`
3. Run `esy build`
**testing**
```
esy make test
```
**Running commands**
If you want to run commands that work directly on the project, you must always prefex them with
`esy x` in order to run the command in the sandboxed environment.
## Attribution
lwt-node would not be possible without all the hard work from the maintainers
and contributors of of lwt. lwt-node is powered by lwt and the ocaml standard lib.
Lwt provides a battle tested promise implementation and async operators. If you love lwt-node
I recommend showing love to the [lwt project](https://github.com/ocsigen/lwt).
## License
MIT