https://github.com/robertdp/engineering-test-api
Minimalistic API made for an engineering test
https://github.com/robertdp/engineering-test-api
functional-programming purescript
Last synced: 2 months ago
JSON representation
Minimalistic API made for an engineering test
- Host: GitHub
- URL: https://github.com/robertdp/engineering-test-api
- Owner: robertdp
- Created: 2018-05-15T08:31:51.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-08-06T03:51:40.000Z (over 7 years ago)
- Last Synced: 2025-05-16T23:33:44.718Z (10 months ago)
- Topics: functional-programming, purescript
- Language: PureScript
- Homepage:
- Size: 79.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
### Usage
First, install `yarn`:
```
$ npm install --global yarn
```
Then install the server dependencies:
```
$ yarn install
```
And finally, to build and run the server:
```
$ yarn
```
Note: You might need to disable CORS in your browser for the client-side app to communicate with the API.
#### Command listing
Run:
```
$ yarn
```
| Command | Action |
| ------- |------- |
| `install` | Install Node.js and PureScript dependencies |
| `build` | Clean and build the project |
| `clean` | Remove all build artifacts |
| `watch` | Watch for file changes, rebuilding and restarting the server |
| `ide` | Start the interactive development tool |
| `start` | Run the server |
| `test` | Run the tests (currently no tests) |
### Todo
- Logging
- Metrics
- Refactoring and DSL development
### Further reading
**PureScript By Example**
Free book by the creator of PureScript
https://leanpub.com/purescript