Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/f4str/sauce-searcher
Search for the anime, manga, light novel, visual novel, and doujin sauce
https://github.com/f4str/sauce-searcher
anime fastapi fullstack manga python react semantic-ui typescript web-application
Last synced: 6 days ago
JSON representation
Search for the anime, manga, light novel, visual novel, and doujin sauce
- Host: GitHub
- URL: https://github.com/f4str/sauce-searcher
- Owner: f4str
- License: mit
- Created: 2020-12-20T00:04:04.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2022-05-23T06:45:25.000Z (over 2 years ago)
- Last Synced: 2024-10-14T21:53:29.530Z (2 months ago)
- Topics: anime, fastapi, fullstack, manga, python, react, semantic-ui, typescript, web-application
- Language: TypeScript
- Homepage: https://f4str.github.io/sauce-searcher
- Size: 2.65 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Sauce Searcher
Sauce searcher is a fullstack application used to search and get information for anime, manga, light novels, visual novels, and doujins. When built, the application can be run either locally on deployed online to a web service. A sample instance of the application can be found at .
## Technologies
Since this is a fullstack application, the server and client are separated into two separate directories that need to be run together.
* The server is a `Python` application that uses `FastAPI` and `uvicorn` to create a REST API to perform HTTP GET requests.
* The client is a `Node.js` application with `TypeScript` that uses `React` creates a web interface which performs API calls to the server.
## Requirements
The server and client both require their own requirements. For the server ensure the following are installed.
* `Python`
* `pip`
* `venv`
For the client ensure the following are installed.
* `Node.js`
* `Yarn`
For more details on how to install each requirement, view the `README.md` on the respective server or client directory.
## Quickstart
After installing all the requirements, clone the repository.
```bash
git clone https://github.com/f4str/sauce-searcher
```
Open two terminals in the cloned directory. One terminal will be used for the server and the other will be used for the client.
In one terminal, change run the following commands to install all dependencies and launch the server.
```bash
# change directories to the server
cd server
# create new virtual environment using venv
python3 -m venv venv
source venv/bin/activate
# install all dependencies using pip
pip install -e .[dev]
# start the server
./run.sh
```
In the other terminal, run the following commands to install all dependencies and launch the client.
```bash
# change directories to the client
cd client
# install all dependencies using yarn
yarn
# start the client
yarn start
```
The application is available on .
For more information or details on either the server or client separately, view the `README.md` for the respective directory.