https://github.com/jotrorox/fbapi

A dead simple API that exposes endpoints for "Fizz Buzzing"
https://github.com/jotrorox/fbapi

api coding-sloth fizzbuzz render rocket rust sloth-bytes

Last synced: 2 months ago
JSON representation

A dead simple API that exposes endpoints for "Fizz Buzzing"

• Host: GitHub
• URL: https://github.com/jotrorox/fbapi
• Owner: Jotrorox
• License: agpl-3.0
• Created: 2024-06-08T18:50:04.000Z (7 months ago)
• Default Branch: master
• Last Pushed: 2024-09-04T20:07:01.000Z (4 months ago)
• Last Synced: 2024-09-26T07:20:39.980Z (3 months ago)
• Topics: api, coding-sloth, fizzbuzz, render, rocket, rust, sloth-bytes
• Language: Rust
• Homepage: https://fbapi-gh6l.onrender.com
• Size: 44.9 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
FizzBuzz API




  

  

  

  

  

  







  About   |   

  Features   |  

  Development Requirements   |  

  Development Setup   |  

  Getting Started   |  

  Contributing   |  

  License   |  

  Author






## :dart: 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.](https://slothbytes.beehiiv.com/subscribe?ref=leLwLkdsZI)).

And it is just meant as a simple exercise, since I don't think this can ever come in handy.

## :sparkles: 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.

:heavy_check_mark: Fizz Buzzing\

:heavy_check_mark: Multiple Number queries\

:heavy_check_mark: Random Numbers & Number ranges\

:heavy_multiplication_x: 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](https://jotrorox.com/))**

## :white_check_mark: Development Requirements ##

Before starting :checkered_flag:, you need to have [Git](https://git-scm.com) and a [Rust](https://rustup.rs) installed.

## :checkered_flag: Starting (Development Setup) ##

```bash

# 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**

## :dash: Getting Started ##

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

## :raised_hands: 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

## :memo: License ##

This project is under the AGPLv3 License. For more details, see the [LICENSE](LICENSE) file.




Made with :heart: by Jotrorox

 

Back to top