Go to file
2024-10-17 15:41:09 +02:00
build odio cpp 2024-10-17 15:41:09 +02:00
src odio cpp 2024-10-17 15:41:09 +02:00
utility odio cpp 2024-10-17 15:41:09 +02:00
CMakeLists.txt odio cpp 2024-10-17 15:41:09 +02:00
Dockerfile Modificacion de dockerfile 2024-10-17 12:45:32 +02:00
LICENSE Initial commit 2024-10-17 11:22:56 +02:00
README.md Actualizar README.md 2024-10-17 12:13:36 +02:00

Malackathon Backend

Malackathon CyberBokeron backend repo.

C++ Oat++ License

Table of Contents


Description

This project is a backend API server for Malackathon CyberBokeron, built using C++ and Oat++, a lightweight and fast web framework for building REST APIs.

Features

  • 🚀 High-performance backend with Oat++
  • 📚 Clean API structure with REST endpoints
  • 🧩 Modular design and scalability
  • 🛡️ Integrated error handling and logging
  • ⚙️ Easy to extend and customize

Tech Stack

  • Language: C++17 or later
  • Framework: Oat++
  • Build System: CMake
  • Database: [OracleSQL] (optional)
  • Testing: [Unit testing library]

Installation

Before you begin, ensure you have the following installed:

Step-by-step Installation

  1. Clone the repository:

    git clone 
    
  2. Navigate into the project directory:

    cd Malackathon-backend
    
  3. Create a build directory and configure the project using CMake:

    mkdir build && cd build
    cmake ..
    
  4. Build the project:

    make
    
  5. (Optional) Run the tests if available:

    make test
    

Usage

To start the server, run the following command in the build directory:

./project-executable

By default, the server will be accessible at http://localhost:8000. You can change the port and other settings in the configuration file.

Environment Variables

You can configure the server using environment variables. Example:

export SERVER_PORT=8080
export DATABASE_URL=postgres://user:password@localhost:5432/dbname

API Endpoints

  • GET /api/example - Fetches example data.
  • POST /api/example - Creates a new example entry.

For a detailed list of endpoints, see the API documentation (poner algo aqui).

Contributing

Contributions are welcome! To contribute, follow these steps:

  1. Fork the repository.
  2. Create a new feature branch (git checkout -b feature-new-feature).
  3. Commit your changes (git commit -am 'Add new feature').
  4. Push your branch (git push origin feature-new-feature).
  5. Open a Pull Request.

Please ensure your code follows the projects coding guidelines and passes all tests.

License

This project is licensed under AGPLv3 license.