WorldSwissKnifeAPI 🇨🇭🔪

Rest API which is also a swiss knife and to which you can add all the features you want, and like many others, it's a REST API just for experimenting and laughing 🇨🇭🔪...

Introduction,
Presentation,
Features,
Project's structure,
Project's development,
Deployment,
- Source code,
- Docker
- Heroku
- Balena
Conclusion
Useful links

Introduction

Presentation

Features

Of course, other features can be added to this API. To learn how and have a manual guide, please go here...

Project's structure

Project's development

Deployment

Source code

Firstly, you need to clone the corresponding repository from GitHub, using the following command :

git clone https://github.com/Vicken-Ghoubiguian/WorldSwissKnifeAPI

Second, you must position yourself in the WorldSwissKnifeAPI directory thus generated, again using the following command :

cd WorldSwissKnifeAPI

Thirdly, you must install all of the required Python packages listed in the requirements.txt file :

pip3 install -r requirements.txt

Fourthly and lastly, you must launch the main.py file using the following command :

python3 main.py

This command is equivalent to this one below :

python main.py

It's now the time to enjoy yourself 😸...

Docker

Requirements

From DockerHub

The Docker image on Docker Hub is available just here...

First, to get started, you need to pull this Docker image through this command bellow :

docker pull wicken/worldswissknifeapi:latest

Secondly and finally, you have to run a new Docker container from this Docker image using the command bellow :

docker container run -d --name worldswissknifeapi -p 80:80 wicken/worldswissknifeapi:latest

It's done now... So enjoy yourself 😸...

From Dockerfile

First of all, you must clone the project's repo on GitHub thanks to the command bellow :

git clone https://github.com/Vicken-Ghoubiguian/WorldSwissKnifeAPI

Then, you have to position yourself in the WorldSwissKnifeAPI directory thus generated :

cd WorldSwissKnifeAPI

docker image build -t worldswissknifeapi:latest .

docker container run -d --name worldswissknifeapi -p 80:80 worldswissknifeapi:latest

vicken-ghoubiguian / worldswissknifeapi Goto Github PK