Demo API

This is an API built only for demo purposes of ScanAPI. It can be accessed at https://demo.scanapi.dev/.

Development

How to run demo-api locally

The setup process's prerequisites are Python 3.6+, pip and git installed in your system.

1. Fork scanapi/demo-api

• Fork a repo in your github account such as you get yourusername/demo-api. Now that you own a copy of the repo, you can easily clone the repo with the command below so that you can start making changes to the repo.

git clone https://github.com/<your username>/demo-api.git

2. Create and activate a new virtual environment

• For creating virtual environment we are using the method mentioned in the Python documentation.

python3 -m venv DemoAPI
source DemoAPI/bin/activate

• Feel free to use any other library like virtualenv or virtualenvwrapper for creating a new environment if you have any other prefrences.

3. Install the demo-api dependencies

cd demo-api
pip install -r requirements.txt

4. Make migrations and run the demo-api

python manage.py migrate
python manage.py runserver

• If everything runs smoothly without any errors you should see the API live at http://127.0.0.1:8000/. Feel free to create an issue if run into problems while setting up the project.

Deployment

Currently the demo-api is hosted on Fly.io. Whenever any branch is merged into the main branch a new deployment is triggered at demo.scanapi.dev via GitHub Actions

You can check the status/activity log of the current deployment as well as the past ones here.