decodeproject / restroom Goto Github PK

View Code? Open in Web Editor NEW

Easy REST API builder executing Zencode over endpoints

License: GNU Affero General Public License v3.0

Python 83.11% Dockerfile 16.89%

restroom's Introduction

${project_name}$

{project_name}
_{tagline}

🐳 Docker • 🔧 Configuration • 😍 Acknowledgements • 🌐 Links • 👥 Contributing • 💼 License

🚩 Table of Contents (click to expand)

Docker
Configuration
Acknowledgements
Links
Contributing
License

🐳 Docker quickstart

docker build -t restroom .
docker run -p 8000:8000 --rm -it restroom

head your browser to http://localhost:8000/docs

🔧 Configuration

Configuration available at tihs time is:

RESTROOM_CONFIG_FILE

That is read by .env or Environment variables

😍 Acknowledgements

Designed, written and maintained by Puria Nafisi Azizi.

Special thanks to Jaromil for this superb idea.

This project is receiving funding from the European Union’s Horizon 2020 research and innovation programme under grant agreement nr. 732546 (DECODE).

🌐 Links

https://www.decodeproject.eu/

https://www.zenroom.org/

https://dyne.org/

👥 Contributing

Please first take a look at the Dyne.org - Contributor License Agreement then

🔀 FORK IT
Create your feature branch git checkout -b feature/branch
Commit your changes git commit -am 'Add some fooBar'
Push to the branch git push origin feature/branch
Create a new Pull Request
🙏 Thank you

💼 License

Restroom - {tagline}
Copyright (c) 2019 Dyne.org foundation, Amsterdam

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

Recommend Projects