opsariichthys-bidens

(โ˜… 124)

Building a Basic Information API for Chinese National Universities in the Handheld College Entrance Examination Based on Fastapi.

  • .dockerignore
  • .gitignore
  • Dangerfile
  • docker_run.py
  • Dockerfile
  • env.py
  • LICENSE
  • local_driver.py
  • README.md
  • requirements.txt
  • run.py

# Installation Guide

1. Get the code
git clone https://github.com/touero/opsariichthys-bidens

Downloads the entire project code from GitHub to your computer.

cd opsariichthys-bidens

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
sudo docker build -t opsariichthys_bidens:lastest .

Builds a runnable image based on the Dockerfile.

docker run -d -v "$(pwd):/app" -p 2518:2518 --name opsariichthys_bidens opsariichthys_bidens:lastest

Runs the built image as an actual container.

<a href="https://www.docker.com/"><img src="https://img.shields.io/badge/docker-grey?style=plastic&logo=docker" alt=""></a>

Type this command into your terminal and run it.

โœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

3. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
python -m venv venv && source ./venv/bin/activate

Runs the Python script (or module).

pip install -r requriements.txt

Installs the Python libraries listed in requirements.txt (or similar).

โœ… If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

// repository documentation