Git Product home page Git Product logo

scratchql's Introduction

ScratchQL Build License: GPL v3

A relational database management system from scratch


This page is about

  • the goal of this project
  • how to set up the project for development
  • how to contribute to this project
  • testing your code
  • details about the project

Goal

This project aims to build a relational database management system (short RDBMS) from scratch, in c++20. It should be ACID and implement basic CRUD functionality. It should Consistent, Available and thus not Partitioned (see CAP). Also, latency shall be minimised at the cost of bandwidth.

Setup

  • Clone this repository
  • Make sure the following tools are installed:
    • an ISO C++20-compliant compiler
    • catch2, glog, make, cmake
  • Run bash setup/git-config to setup git hooks
  • We recommend JetBrain’s CLion due to its integrated build automation. If you use other IDEs, update the .gitignore file accordingly.

Contribution

  • Fork our GitHub Repo
  • Commit guidelines: see Karma Runner
  • Pushing your changes:
    • Create Pull Requests for changes
    • PR titles should follow the commit guidelines
    • At least one review is required for approval
    • Merge through Squash’n Merge
  • All production code belongs in /src/* which mirrors
    • our Model-View-Controller architecture
    • our use of our object orientation
      • Single inheritance, subclasses in subfolders

Testing

  • Logging Framework: Glog (Google logging)
  • Testing framework: Catch2
  • Behaviour-driven development where applicable, otherwise test-driven
  • All testing belongs in /test/*
  • /test/* should mirror /src/* in its folder structure

About

Semester Project Spring 2020 at CODE University of Applied Sciences

Copyright (C) 2020 Aaron Alef [email protected] @anarchuser

scratchql's People

Contributors

anarchuser avatar fbachus avatar

Stargazers

Fabio Fracassi (CODE University) avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.