Darkn
/
bash-fastapi
6
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

80 column rule

This commit is contained in:
Ivan Kovmir 2023-06-17 10:38:35 +02:00
parent 6aa6e3d312
commit cef0152d25
Signed by: kovmir
GPG Key ID: ECF867166654C9EA
1 changed files with 22 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@ -1,8 +1,9 @@
# What's this?
This repository contains database of all quotes from the famous website bash.im as well as the API that allows self-hosting your own quotes website.
All of this started in February 2022 when bash.im was shut down.
Quotes were parsed from the web archive.
This repository contains database of all quotes from the famous website bash.im
as well as the API that allows self-hosting your own quotes website. All of
this started in February 2022 when bash.im was shut down. Quotes were parsed
from the web archive.
# Requirements
@ -14,7 +15,9 @@ Quotes were parsed from the web archive.
```bash
# Clone this repository and enter it:
git clone https://git.darkn.space/Darkn/bash-fastapi.git
# Download the quotes.sqlite3 using Git LFS and replace the pointer file with the actual database:
cd bash-fastapi
# Download the quotes.sqlite3 using Git LFS
# and replace the pointer file with the actual database:
git lfs pull
# Configure virtualenv:
python3 -m venv .venv
@ -28,18 +31,21 @@ python main.py
# FAQ
### How do I change the port on which API runs?
**Q: How do I change the port on which API runs?**
Default port is 8001, but you can change it inside of main.py by modifying those lines at the very end:
A: Default port is 8001, but you can change it inside of main.py by modifying
those lines at the very end:
```python
if __name__ == "__main__":
uvicorn.run(app, port=8001, host="0.0.0.0")
```
### Why is quotes.sqlite3 so small and has no quotes inside of it after I cloned your repository?
**Q: Why is quotes.sqlite3 so small and has no quotes inside of it after I
cloned your repository?**
You probably forgot to install and/or use Git LFS. Go to the repository directory and run following commands:
A: You probably forgot to install and/or use Git LFS. Go to the repository
directory and run following commands:
```bash
git lfs install
@ -47,12 +53,16 @@ git lfs fetch
git lfs checkout
```
You can read more about using Git LFS [here](https://docs.github.com/en/repositories/working-with-files/managing-large-files/installing-git-large-file-storage) and [here](https://stackoverflow.com/questions/72610494/what-is-the-difference-between-git-lfs-fetch-git-lfs-fetch-all-and-git).
You can read more about using Git LFS
[here](https://docs.github.com/en/repositories/working-with-files/managing-large-files/installing-git-large-file-storage)
and
[here](https://stackoverflow.com/questions/72610494/what-is-the-difference-between-git-lfs-fetch-git-lfs-fetch-all-and-git).
### Do you really have all quotes from bash.im?
**Q: Do you really have all quotes from bash.im?**
As long as it was indexed by the web archive, it's there.
A: As long as it was indexed by the web archive, it's there.
# Credits:
Thanks to ~~The Man, the Myth, the Legend~~ the Darkn member gameeroor for helping with parsing and making such a nice API.
Thanks to ~~The Man, the Myth, the Legend~~ the Darkn member gameeroor for
helping with parsing and making such a nice API.