Skip to content

README.md

Latest commit

 

History

History
110 lines (80 loc) · 3.36 KB

README.md

File metadata and controls

110 lines (80 loc) · 3.36 KB

PBin-cpp

This is a simple code snippet sharing web application, similar to pastebin, made with Drogon C++ Framework. It's completely anonymous, though I'm planning on bringing here some convenient authentication.

Table of Contents

Prerequisites

Before you begin, ensure you have the following installed:

  • C++ Compiler: A C++20 compatible compiler.
  • CMake: Version 3.10 or higher.
  • PostgreSQL: A running PostgreSQL server.
  • Drogon: The Drogon C++ web framework. Shipped as a submodule.
  • jwt-cpp: The JWT (JSON Web Tokens) library for C++. Shipped as a submodule.
  • libpq-dev: The PostgreSQL client library development headers.
  • uuid-dev: The UUID library development headers.

Cloning the Repository

  1. Open your terminal and navigate to the directory where you want to clone the project.

  2. Run the following command:

    git clone --recursive --depth=1 --shallow-submodules https://github.com/1Kuso4ek1/PBin-cpp.git
cd PBin-cpp

    Note: The --depth=1 --shallow-submodules flags are used for faster cloning. If you need to work with the Drogon submodule directly (e.g., switch branches), you might need to clone without these flags.

Building the Project

  1. Create a build directory:

    mkdir build
cd build

  2. Configure the project using CMake:

    cmake .. -DCMAKE_BUILD_TYPE=Release

  3. Build the project:

    make -j$(nproc)

Database Setup

  1. Create a Database:

    • Connect to your PostgreSQL server using psql or a GUI tool like pgAdmin.
    • Create a new user and database.
    • For example: 
      CREATE USER your_db_user WITH PASSWORD 'your_db_password';
CREATE DATABASE pbin WITH OWNER your_db_user;
GRANT ALL PRIVILEGES ON DATABASE pbin TO your_db_user;
      • Replace your_db_user, your_db_password, and pbin with your desired username, password, and database name.

  2. Create tables:

    • You need to create tables in a database.
    • In the sql folder you can find create_tables.sql file, which contains all the necessary queries.
    • Connect to your database using psql or pgAdmin: 
      psql -U your_db_user -d pbin
    • Run the create_tables.sql file: 
      \i /path/to/this/project/sql/create_tables.sql
      • Replace /path/to/this/project/sql/create_tables.sql with the actual path to the file.

Configuration

There's a config/config-template.json file, which you should use as a template for your configuration. You can either make changes to this file directly, or copy/rename/move it. Either way, you need to fill in your database credentials, server port, and other settings.

Running the Application

  1. Navigate to the build directory:

    cd build

  2. Run the executable:

    ./backend

    This will start the Drogon web server.

  3. If you moved the default config/config-template.json file, you can provide a path to your config file as an argument:

    ./backend /path/to/your/config.json