https://github.com/phmatray/geometrix
A web api to generate geometric images
https://github.com/phmatray/geometrix
Last synced: 6 months ago
JSON representation
A web api to generate geometric images
- Host: GitHub
- URL: https://github.com/phmatray/geometrix
- Owner: phmatray
- License: bsd-3-clause
- Created: 2021-11-24T17:09:39.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2025-02-14T14:10:28.000Z (11 months ago)
- Last Synced: 2025-03-27T01:48:45.353Z (10 months ago)
- Language: C#
- Size: 630 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 26
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Geometrix
Geometrix is a web API that generates geometric images based on user-defined parameters. It uses a combination of mirror power, cell group length, cell width pixel, seed, and color themes to create unique and visually appealing geometric patterns.
## Features
- Generate geometric images with customizable parameters
- Save generated images as PNG files
- Retrieve saved images
## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
### Prerequisites
- .NET 8.0 or later
- A suitable IDE such as JetBrains Rider or Visual Studio
### Installing
1. Clone the repository ```git clone https://github.com/phmatray/Geometrix.git```
2. Navigate to the project directory ```cd Geometrix```
3. Restore the packages ```dotnet restore```
4. Build the project ```dotnet build```
5. Run the project ```dotnet run --project Geometrix.WebApi/Geometrix.WebApi.csproj```
## Usage
To generate an image, make a POST request to `/api/GenerateImage` with the following parameters:
- `mirrorPowerHorizontal`: (integer) The mirror power in the horizontal direction.
- `mirrorPowerVertical`: (integer) The mirror power in the vertical direction.
- `cellGroupLength`: (integer) The length of the cell group.
- `cellWidthPixel`: (integer) The width of the cell in pixels.
- `includeEmptyAndFill`: (boolean) Whether to include empty and fill cells.
- `seed`: (integer) The seed for the random number generator.
- `backgroundColor`: (string) The background color in hexadecimal format.
- `foregroundColor`: (string) The foreground color in hexadecimal format.
## Contributing
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details