https://github.com/fabioluz/fun-js

Functional NodeJS Application Example
https://github.com/fabioluz/fun-js

functional-programming javascript nodejs

Last synced: 6 days ago
JSON representation

Functional NodeJS Application Example

• Host: GitHub
• URL: https://github.com/fabioluz/fun-js
• Owner: fabioluz
• Created: 2018-07-13T15:36:11.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-02-28T13:34:56.000Z (9 months ago)
• Last Synced: 2024-02-29T13:56:04.035Z (9 months ago)
• Topics: functional-programming, javascript, nodejs
• Language: JavaScript
• Size: 216 KB
• Stars: 15
• Watchers: 1
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Fun JS

Fun JS is a NodeJS application created to learn and apply functional-programming principles for real-world applications. Any corrections or additional implementations are welcome! 

### Libraries Used

* [Sanctuary](https://github.com/sanctuary-js/sanctuary) for a run-time type checking and helper functions;

* [Fluture](https://github.com/fluture-js/Fluture) for a monadic data structure alterative to Promises;

* [Koa](https://github.com/koajs/koa) for serving a Restful API;

* [Postgres-Migrations](https://github.com/ThomWright/postgres-migrations) for an immutable database migration system.

### Running the app

1. Clone the app and install the packages;

2. Install PostgreSQL, if you don't have it;

3. Create a `.env` file in the root of the project. This file should contain the following keys:

```

// change the values as necessary

APP_PORT = 3000

PGHOST = localhost

PGUSER = postgres

PGPASSWORD = YOUR_POSTGRESQL_PASSWORD

PGPORT = 5432

PGDATABASE = fun_js

```

4. Run `npm run migrate`;

5. Run `npm run serve`;

6. Enjoy ;)

### Using the app

There are current 2 routes available:

* `GET api/users`

* `POST api/users`

```

{

	"email": "[email protected]",

	"password": "1234567",

	"fullname": "Test Name"

}

```

Try to change/remove the fields and see what happens :)

### Philosophy

The idea of this app is to separate the algebra from the interpretation of the functions, as if we were using a strongly-typed language. I'm still not sure whether it's really make sense, so I created this application to test the concepts and get reviews and pull-requests from other people.