https://github.com/reasonml-community/bs-express

Express bindings in Reason
https://github.com/reasonml-community/bs-express

bucklescript expressjs javascript nodejs ocaml reasonml

Last synced: 1 day ago
JSON representation

Express bindings in Reason

• Host: GitHub
• URL: https://github.com/reasonml-community/bs-express
• Owner: reasonml-community
• License: mit
• Created: 2016-09-06T04:27:32.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2021-10-18T07:23:43.000Z (about 3 years ago)
• Last Synced: 2024-11-06T10:06:50.364Z (9 days ago)
• Topics: bucklescript, expressjs, javascript, nodejs, ocaml, reasonml
• Language: ReScript
• Size: 615 KB
• Stars: 210
• Watchers: 6
• Forks: 60
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-list - bs-express - community | 211 | (ReScript)

README

        
# bs-express

Express bindings for [BuckleScript](https://github.com/bloomberg/bucklescript) in [Reason](https://github.com/facebook/reason).

## Installing

1. Install `bs-express` using npm:

```

npm install --save bs-express

```

2. Add bs-express as a dependency to your `bsconfig.json`:

```json

{

  "name": "your-project",

  "bs-dependencies": ["bs-express"]

}

```

---

Right now the library is somewhat underdocumented, so please view the interface file [`Express.rei`](./src/Express.rei) or the [example folder](./example/) to see library usage.

---

## Contributing

If you'd like to contribute, you can follow the instructions below to get things working locally.

### Getting Started

1. After cloning the repo, install the dependencies

```shell

npm install

```

2. Build and start the example server:

```shell

npm start

```

### Running the tests

To run tests, run the command:

```shell

npm test

```