ziegelstein/duck_api

An API to dispatch ducks.

Duck Api

This is a small fun project to make ducks more accessiable to the world! It exposes duck endpoints to the public and also has a small backend for adding more duck content. It is heavily work in progress. [Watch the demo]("https://duck.ziegel.me") to see it in action!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Duck Api should provide a simple rest-api that delivers ducks. It is by no means a professional service, it just is a small attempt to duckify the internet a little bit more

(back to top)

Built With

• 
• 
• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

To start developing on the project, please follow these instructions:

Prerequisites

For Development, Python3, Pip, Venv are requiered, Docker is suggested. The project can run both on bare-metal or docker, docker is the prefered way.

Arch

• pip

    pacman -S python-pip 

• venv

   python3 -m pip install virtualenv

Ubuntu

• pip

    sudo apt install python3-pip python

• venv

    sudo pip3 install virtualenv

Installation-Dev

0. Clone the repo

   git clone https://github.com/Ziegelstein/duck_api.git

1. Enter venv

   source bin/activate

2. Install project requierements

   pip3 install -r requirements.txt

Run on Docker

0. Clone the repo

   git clone https://github.com/Ziegelstein/duck_api.git

1. Run docker compose

   docker-compose up -d

(back to top)

Usage

The useage will be fully documented in a future update.

For more examples, please refer to the Documentation

(back to top)

Roadmap

• Finish the outputs
• Setup a test library
• Add Dynamic Duck Facts
• Add ducks to demo server
  • Find a solution to duck copyright
• Setup a helm-chart

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Ziegelstein - @Ziegelstein 🧱#5926 - dev@ziegel.me

Project Link: https://github.com/Ziegelstein/duck_api

(back to top)

Acknowledgments

None yet, but maybe someone wants to contribute?

(back to top)