Skip to content

Commit

Permalink
add links to README
Browse files Browse the repository at this point in the history
  • Loading branch information
devlinjunker committed May 1, 2020
1 parent 76c359a commit 396544f
Showing 1 changed file with 14 additions and 12 deletions.
26 changes: 14 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,17 @@ This example can also be used to quickly create a server with your own endpoints
Node v10+ and npm
(tested with v10.15.1)

See [package.json](https://github.com/devlinjunker/template.hapi.rest/blob/master/package.json) for full list of current dependencies
- Hapi v18
- Webpack + Loaders
- Babel
- FlowJS
- ESLint
- Mocha, Chai, Sinon
- EsDoc
- MariaDB
- YamlJS
See package.json([github](https://github.com/devlinjunker/template.webpack.fend/blob/master/package.json))
for full list of current dependencies
- [Hapi v18](https://hapi.dev/) -- Server Library
- [Webpack](https://webpack.js.org/) + [Loaders ](https://webpack.js.org/concepts/loaders/)-- managing the build process
- [Babel](https://babeljs.io/) -- compiling newer ECMA2016+ into browser-capable javascript
- [FlowJS](https://flow.org/) -- adding types to javascript
- [ESLint](http://eslint.org/) -- enforcing javascript code style
- [Mocha](https://mochajs.org/), [Chai](https://www.chaijs.com/), and [Sinon](https://sinonjs.org/) -- unit testing
- [EsDoc](https://esdoc.org/) -- creating easy javascript documentation
- [MariaDB](https://mariadb.org/) -- Connecting to mysql/mariadb server for storage
- [YamlJS](https://openbase.io/js/yamljs) -- Parsing YAML files

## Development

Expand All @@ -30,8 +31,9 @@ How to use this template to create a quick HTTP REST server:
4. Add Controller Files to `src/controllers/`
- For now, add reference to controller in `src/entry.js` (with other controllers)
- Controller endpoints will be served at `/api` (or whatever is set in config.yaml)
5. Run `npm run start-watch` to compile and run server + tests in watch mode
6. Navigate to http://localhost:3333/docs/swagger/index.html to see swagger-ui with your new endpoint
5. Run `npm run doc` to update the documentation
6. Run `npm run start-watch` to compile and run server + tests in watch mode
- Navigate to http://localhost:3333/docs/swagger/index.html to see swagger-ui with your new endpoint

### Tests/Running

Expand Down

0 comments on commit 396544f

Please sign in to comment.