FizzBuzz API

---

About   |   Features   |   Development Requirements   |   Development Setup   |   Getting Started   |   Contributing   |   License   |   Author

🎯 About

fbAPI is a simple API made for 'FizzBuzzing' that means it is just a simple way to fizz buzz one or more numbers. This API was build after the Idea of CodingSloth (I can recommend his Newsletter btw.). And it is just meant as a simple exercise, since I don't think this can ever come in handy.

✨ Features

Just to be clear this has a lot of features that you right now have to find in source. I will provide a more in depth documentation later on but right now I'm sorry but it is what it is.

✔️ Fizz Buzzing
✔️ Multiple Number queries
✔️ Random Numbers & Number ranges
✖️ Docker setup

If you want more info or help just hit me up with the ways listed in the Starting section or on my website (jotrorox.com)

✅ Development Requirements

Before starting 🏁, you need to have Git and a Rust installed.

🏁 Starting (Development Setup)

# Clone this project
$ git clone https://github.com/Jotrorox/fbapi

# Go into that directory
$ cd fbapi

# Build the Project
$ cargo build

# Run the Project
$ cargo run

If you encounter Problems just hit me up, I'm happy to help you get started
You can do that over matrix: @jotrorox:matrix.org or Discord: https://discord.gg/RVr4cceFUt

💨 Getting Started

There is currently no Docker Setup. For now I recommend using my already hosted instance over at: https://fbapi-gh6l.onrender.com

🙌 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

📝 License

This project is under the AGPLv3 License. For more details, see the LICENSE file.

Made with ❤️ by Jotrorox

 

Back to top