# MySiga Docs

Welcome to MySiga API docs! Here you'll find all the documentation you need to get up and running with [Siga 3](https://docs.laravieira.me/mysiga/siga-3) programmatically.

## Wanna rush it?

{% content-ref url="quick-start" %}
[quick-start](https://docs.laravieira.me/mysiga/quick-start)
{% endcontent-ref %}

## What is MySIGA?

MySiga is an unofficial personal project done by [Lara Vieira](https://app.gitbook.com/u/ALDblrvwTLeP2N8ADeVk1LJ7rhg2 "mention"), using [PHP 8](https://www.php.net/releases/8.2/en.php) and implementing concepts like [Web Scraping](https://www.parsehub.com/blog/what-is-web-scraping/). It is an [API](https://en.wikipedia.org/wiki/API) that acts as an intermediate, letting programmatic apps and scripts communicate easily with [UFJF's Siga 3](https://docs.laravieira.me/mysiga/siga-3) for students.

### Free & open-source

If u wanna do a personal small script? u can use the available endpoint at:

```
https://mysiga.laravieira.me
```

{% hint style="info" %}
This is a non-profitable personal project, if u think you are sly and overload the available free end-point with a big app or even a brute-force attack, I don't support u and you gonna get banned. Be cool and help me keep this available for other students to play and learn.
{% endhint %}

If you wanna go crazy and do an app for all your friends? U'll have to deploy MySiga on your own. Checkout the code repo:

{% embed url="<https://github.com/laravieira/mysiga>" %}
GitHub repository
{% endembed %}

{% hint style="info" %}
MySiga is hosted by [fly.io](https://fly.io/) in a free instance, so its repo is configured with auto-deploy to [fly.io](https://fly.io/). Is like [Heroku](https://www.heroku.com/), but still free.
{% endhint %}

### Docker ready

You're a docker lover? You can have MySiga locally with just...

```sh
git clone https://github.com/laravieira/mysiga && cd mysiga
docker build -t mysiga . && docker run -p 80:80 --name mysiga mysiga
```

{% hint style="info" %}
The docker image uses Linux, make sure your docker is on a Linux or WSL.
{% endhint %}

## Resources

{% embed url="<https://github.com/laravieira/mysiga>" %}
GitHub repository
{% endembed %}

{% embed url="<https://docs.laravieira.me/mysiga>" %}
This documentation
{% endembed %}

{% embed url="<https://mysiga.laravieira.me>" %}
API available end-point
{% endembed %}

## Wanna contribute?

U can leave your contributions by:

* [x] Creating a repo issue
* [x] Creating a repo pull request
* [x] Pinging `L4R4V131R4#4424` on [Discord](https://discord.gg/q4yGa9G7hh)

## Disclaimer

This project has no partnership with UFJF, this is an unofficial personal project, and it's public to incentive students to try coding and learn. Use it on your own, I have no responsibility for what u do with it.

The MySiga name is not registered and can be changed if necessary.