bocadillo

(β˜… 389)

(UNMAINTAINED) Fast, scalable and real-time capable web APIs for everyone

  • .bumpversion.cfg
  • .coveragerc
  • .gitattributes
  • .gitignore
  • .pre-commit-config.yaml
  • .travis.yml
  • CHANGELOG.md
  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md
  • LICENSE
  • package-lock.json
  • package.json
  • PULL_REQUEST_TEMPLATE.md
  • pydocmd.yml
  • pylintrc
  • pytest.ini
  • README.md
  • requirements.txt
  • setup.py

# Installation Guide

1. Get the code
git clone https://github.com/bocadilloproject/bocadillo

Downloads the entire project code from GitHub to your computer.

cd bocadillo

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Python 3 Python is required to use pip.
pip install bocadillo

Installs the package published on PyPI directly β€” no need to clone the source.

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

4. 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.
pip install bocadillo

Installs the package published on PyPI directly β€” no need to clone the source.

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

Pulled directly from this repo's README.

// repository documentation