Browse Source

Add initial README file

feature/search
Bèr Kessels 1 year ago
parent
commit
e140fe78f3
1 changed files with 101 additions and 0 deletions
  1. 101
    0
      README.md

+ 101
- 0
README.md View File

@@ -0,0 +1,101 @@
# Hours

RESTful JSON API for opening hours

## Getting Started

TODO: Finish Make Install
TODO: Provide alternative in docker

### Prerequisites

A Linux machine that supports apt, preferably a recent Ubuntu LTS.

`make install` should ensure all dependencies are installed.

For machines that do not support Make, consider getting another OS, if
anything, as a virtual machine.

For machines that do not have apt, we are open to help on making the
`Makefile` more portable. Pull requests, suggestions and help is
welcome. The ideal situation would be where all common POSIX compliant
systems, will be able to run the Makefile and install dependencies.

### Installing

Install all dependencies with
```bash
make install
```
## Running the tests

Running the tests with

```bash
make test
```

### Integration tests

*Integration tests*, or *end to end* tests, are tests that run
expectations on the full application. It sets up, seeds and connects to
a database and then makes requests through the REST HTTP interface.

These are slow, and will, nor cannot, cover all edge-cases, paths and
exceptions. They cover the happy path, common situations and important
features.

Currently ran inside the entire test-suite. If the suite grows too large,
we will extract these and make them runnable separately.

### Unit tests

*The unit tests* isolate a *module* and test that in isolation.
Unfortunately, JavaScript, nor node, nor its ecosystem of packages are
very clean and test-oriented. Many features, packages or libraries will
inject their behaviour in the global namespace, making it very hard,
sometimes impossible to mock or stub.

There are quite some tests, but not near as much as I would like.

## Deployment

Deploying depends on your environment. Anywhere where NodeJS is
supported will probably run this software.

TODO: describe what config to change in order to deploy to your servers.

```bash
make deploy
```

## Built With

* [NodeJS](https://nodejs.org) - NodeJS
* [express](https://expressjs.com/) - Express web framework
* [open street map](https://openstreetmap.org) - Data source
* [imposm](https://imposm.org/) - imposm3 to import Open Street Map data
into a postgresql database.

## Contributing

TODO: introduce CONTRIBUTING.md

## Versioning

We use [SemVer](http://semver.org/) for versioning. For the versions
available, see the [release-tags on this
repository](https://git.webschuur.com/placebazaar/hours/tags?utf8=%E2%9C%93&search=v)

## Authors

* **Bèr Kessels**

## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details

## Acknowledgments

TODO: describe YoHours, openstreetmap, imposm, opening_hours etc.


Loading…
Cancel
Save