https://github.com/joelluna02/holoapi2
An RESTFul API fanmade based in hololive
https://github.com/joelluna02/holoapi2
anime api-rest flask-api full-stack hololive hololive-english mysql postgresql python3
Last synced: about 1 year ago
JSON representation
An RESTFul API fanmade based in hololive
- Host: GitHub
- URL: https://github.com/joelluna02/holoapi2
- Owner: JoelLuna02
- Archived: true
- Created: 2023-05-24T04:22:56.000Z (about 3 years ago)
- Default Branch: Hololive
- Last Pushed: 2023-06-13T14:52:36.000Z (about 3 years ago)
- Last Synced: 2025-02-23T22:42:03.668Z (over 1 year ago)
- Topics: anime, api-rest, flask-api, full-stack, hololive, hololive-english, mysql, postgresql, python3
- Language: CSS
- Homepage: https://holoapi.onrender.com
- Size: 5.4 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# HoloAPI
An API RESTFul fanmade based in hololive
Welcome! This is the HoloAPI GitHub page. In this section you can explore a bit the source code which is made of this REST API.
**If you want to test our available resources, you can access the [documentation](https://holoapi.onrender.com/docs). It Uses the [Swagger UI.](https://swagger.io/)**
**For more information about how this API works, you can access the [frequently asked questions](https://holoapi.onrender.com/faqs) section.**
If you want to contribute to this project and you have knowledge in web programming, you need to meet the following requirements:
- Knowledge of Python
- Basic knowledge of object-oriented programming.
- Knowledge of Flask for Web application development
- Knowledge in SQLAlchemy, Marshmallow, RESTful and Migrate for the creation of an API and its corresponding database.
- Knowledge of Flask's ApiSpec for API documentation (If you wish, you can import your own documentation, any contribution will be of great help).
You will need:
- Python >= 3.7
- Flask (Stable Version)
- SQLAlchemy (Stable Version)
- APISpec (0.7.0)
- RESTful (Stable Version)
- Migrate
- Gunicorn (To run server)
You can run this application by doing the following on your console:
```bash
git clone https://github.com/JoelLuna02/HoloAPI2
virtualenv venv
source venv/bin/activate
pip install -r requirements.txt
```
**Important**: You can declare local variables JWT_SECRET or a SECRET_KEY to protect your Application, as well as a Postgres-like database and store its corresponding url in the DB_URL variable. You can also declare APISPEC_SWAGGER to display the content of the swagger documentation and then modify the static/swagger-initializer.js file in the URL section and define localhost:5000/swagger/ or a path in question to initialize the local project.
To run this project; type: `flask run --reload` or `gunicorn main:apli`
If you have any questions or problems, you can access the [Issues](https://github.com/JoelLuna02/HoloAPI2/issues) section.