Skip to content

Latest commit

 

History

History
135 lines (107 loc) · 3.9 KB

README.md

File metadata and controls

135 lines (107 loc) · 3.9 KB
Raw

The backend of the Me0w00f Blogger

Welcome to the Me0w00f Blogger project! This endeavor aims to create a blog site that is both feature-rich and visually appealing for our team.

Technology Stack

FastAPI MariaDB Nginx Python

Installation

1. Cloning the Repository

git clone https://github.com/me0w00f/me0w00f_organization_blogger_backend.git me0w00f_backend
cd me0w00f_backend

2. Installing Dependencies

Install the required Python packages:

pip install -r requirements.txt

3. Database Configuration

Ensure MariaDB is installed and configured on your system. Then, proceed to set up the me0w00f database and user:

mysql -u root -p
CREATE DATABASE me0w00f;
GRANT ALL PRIVILEGES ON me0w00f.* TO 'me0w00f'@'localhost' IDENTIFIED BY 'secure_password';
FLUSH PRIVILEGES;

Replace secure_password with a strong, secure password of your choice.

4. Application Configuration

Edit the config.py file to set your database connection details:

......
# Database
DATABASE_URL = "mysql://me0w00f:secure_password@localhost/me0w00f"
......

5. Admin Setup

Create a admin_list.json file to define the administrators responsible for publishing content:

[
  {
    "user_name": "admin1",
    "password": "secure_password_1",
    "email": "admin1@example.com"
  },
  {
    "user_name": "admin2",
    "password": "secure_password_2",
    "email": "admin2@example.com"
  },
  {
    "user_name": "admin3",
    "password": "secure_password_3",
    "email": "admin3@example.com"
  }
]

Make sure to replace the placeholder passwords and email addresses with actual secure credentials.

6. Running the Application

To start the application using uvicorn on Linux, execute the provided shell script:

./run.sh

Alternatively, you can create and edit a systemd service to manage the run.sh script as a service.

  1. Create a systemd service file:

Usually, systemd service files are stored in /etc/systemd/system/. You'll need to create a new service file here.

sudo vim /etc/systemd/system/me0w00f_backend.service
  1. Edit the service file:

Add the following content to your service file, which defines the service and how it should be managed.

[Unit]
Description=Me0w00f Blogger Backend Service
After=network.target
[Service]
User=<username>
Group=<group>
WorkingDirectory=/path/to/me0w00f_backend
ExecStart=/path/to/me0w00f_backend/run.sh
Restart=always
[Install]
WantedBy=multi-user.target

Replace <username> and <group> with the user and group that should run the service, and /path/to/me0w00f_backend with the actual path to your backend directory.

  1. Enable and start the service:

After saving and closing the service file, you can enable the service to start on boot and then start the service immediately.

sudo systemctl enable me0w00f_backend.service
sudo systemctl start me0w00f_backend.service
  1. Check the service status:

To ensure that the service is running properly, you can check its status with the following command:

sudo systemctl status me0w00f_backend.service
  1. Managing the service:

You can use standard systemctl commands to start, stop, restart, and check the status of your service.

sudo systemctl start me0w00f_backend.service    # To start the service
sudo systemctl stop me0w00f_backend.service     # To stop the service
sudo systemctl restart me0w00f_backend.service  # To restart the service
sudo systemctl status me0w00f_backend.service   # To check the service