Twitter-API is an API server written in FastAPI, which is a modern, fast (high-performance), web framework for building APIs with Python.
Use the package manager pip to install the requirements of this project.
pip install -r requirements.txtTo run the application, you need first to tell your terminal the application to work with by exporting the environment variables that connects the application to your database.
By default the application sets username as root, password as password, host as localhost, port as 3306 and "twitter" as the database's name.
You can modify it by sets those environment variables.
For instance, using Powershell it would look like this:
$env:USERNAME = "your username"
$env:PASSWORD = "your password"
$env:HOST = "your host machine"
$env:PORT = "port number"
$env:DB_NAME = "your database name"
Afterwards you can run the application:
python main.py
This command will start the web server on your localhost on port 8000 by default.
You can also run this project as a docker container. In order to do so, you have to install docker on your machine. Then, all you need to do is to run this command:
docker-compose -f docker-compose.yml up
This command will start 3 containers:
- API
- MySQL
- Adminer - UI for MySQL
Afterwards, you can interact with the web server on port 8000 and the MySQL server via adminer on port 8080. To login the MySQL server via the adminer, you will have to provide some credentials:
Server: mysql
Username: root
Password: password
Database: twitter