Compare commits
No commits in common. "cef0152d25d31bd514e5189779790f5b452a707c" and "84eeeb02a6479d9f2a7844f495a7a39dd018b1e4" have entirely different histories.
cef0152d25
...
84eeeb02a6
50
README.md
50
README.md
|
@ -1,23 +1,17 @@
|
||||||
# What's this?
|
# What's this?
|
||||||
|
|
||||||
This repository contains database of all quotes from the famous website bash.im
|
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.
|
||||||
as well as the API that allows self-hosting your own quotes website. All of
|
All of this started in February 2022 when bash.im was shut down.
|
||||||
this started in February 2022 when bash.im was shut down. Quotes were parsed
|
Quotes were parsed from the web archive.
|
||||||
from the web archive.
|
|
||||||
|
|
||||||
# Requirements
|
# Requirements
|
||||||
|
|
||||||
- Python 3.8+ (Python 3.11 is recommended)
|
- Python 3.8+ (Python 3.11 is recommended)
|
||||||
- Git LFS for fetching the quotes DB
|
- Git LFS for fetching the quotes DB
|
||||||
|
|
||||||
# Quickstart
|
# Quickstart
|
||||||
|
```
|
||||||
```bash
|
|
||||||
# Clone this repository and enter it:
|
# Clone this repository and enter it:
|
||||||
git clone https://git.darkn.space/Darkn/bash-fastapi.git
|
git clone https://git.darkn.space/Darkn/bash-fastapi.git
|
||||||
cd bash-fastapi
|
# Download the quotes.sqlite3 using Git LFS and replace the pointer file with the actual database:
|
||||||
# Download the quotes.sqlite3 using Git LFS
|
|
||||||
# and replace the pointer file with the actual database:
|
|
||||||
git lfs pull
|
git lfs pull
|
||||||
# Configure virtualenv:
|
# Configure virtualenv:
|
||||||
python3 -m venv .venv
|
python3 -m venv .venv
|
||||||
|
@ -30,39 +24,25 @@ python main.py
|
||||||
```
|
```
|
||||||
|
|
||||||
# FAQ
|
# FAQ
|
||||||
|
### 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:
|
||||||
|
|
||||||
**Q: How do I change the port on which API runs?**
|
```python3
|
||||||
|
|
||||||
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__":
|
if __name__ == "__main__":
|
||||||
uvicorn.run(app, port=8001, host="0.0.0.0")
|
uvicorn.run(app, port=8001, host="0.0.0.0")
|
||||||
```
|
```
|
||||||
|
|
||||||
**Q: Why is quotes.sqlite3 so small and has no quotes inside of it after I
|
### Why is quotes.sqlite3 so small and has no quotes inside of it after I cloned your repository?
|
||||||
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
|
git lfs install
|
||||||
git lfs fetch
|
git lfs fetch
|
||||||
git lfs checkout
|
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
|
### Do you really have all quotes from bash.im?
|
||||||
[here](https://docs.github.com/en/repositories/working-with-files/managing-large-files/installing-git-large-file-storage)
|
As long as it was indexed by the web archive, it's there.
|
||||||
and
|
|
||||||
[here](https://stackoverflow.com/questions/72610494/what-is-the-difference-between-git-lfs-fetch-git-lfs-fetch-all-and-git).
|
|
||||||
|
|
||||||
**Q: Do you really have all quotes from bash.im?**
|
|
||||||
|
|
||||||
A: As long as it was indexed by the web archive, it's there.
|
|
||||||
|
|
||||||
# Credits:
|
# Credits:
|
||||||
|
|
||||||
Thanks to ~~The Man, the Myth, the Legend~~ the Darkn member gameeroor for
|
Thanks to ~~The Man, the Myth, the Legend~~ the Darkn member gameeroor for helping with parsing and making such a nice API.
|
||||||
helping with parsing and making such a nice API.
|
|
||||||
|
|
Loading…
Reference in New Issue