Skip to content

Latest commit

 

History

History
47 lines (31 loc) · 1.89 KB

README.md

File metadata and controls

47 lines (31 loc) · 1.89 KB

RestFn

Functional style rest framework

Documentation Status Build Status Scrutinizer Code Quality Code Coverage Code Intelligence Status

User guide

User guide is available on https://restfn.readthedocs.io/en/latest

Manual generation

  1. Install Python and pip.
  2. Install mkdocs with pip install mkdocs
  3. From project's directory run mkdocs build
  4. Manual will be built in the site folder.

Testing

Testing is done using PHPUnit

  • To run all tests run composer test
  • To generate test coverage run composer coverage

Project status

You can track current project status at: https://trello.com/b/iksUgezA/restfn-framework

License

Copyright 2020 Aleksandar Panic

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0 or in this repository

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.