DmitrTRC / dsfs

Develop Symply File System

LevelUP C/C++ Course Project Simple File System

About the project:
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

This is a Final project for the LevelUP course. Contains the following:

• CMakeLists.txt : CMake configuration file
• README.md : project description
• LICENSE.md : project license
• src/ : source code directory ( contains sub-folders with HW and code )
• include/ : header files directory
• img/ : images directory
• doc/ : Current works TODO list
• lib/ : libraries directory
• tests/ : test directory
• tools/ : tools directory ( contains createdb.sql for manual database creation )
• App/ : App directory ( contains main.cpp file )
• docs/ : documentation directory ( contains sub-folders with documentation )
• Doxyfile : Doxygen configuration file
• bin/ : binary directory ( contains executable file )
• .github : GitHub repository settings CI/CD workflow.

(back to top)

Built With

• Clang
• Git
• CMake
• Doxygen
• Docker
• Alpine Linux

(back to top)

Getting Started

Be sure to have the following installed:

C Compiler, C++ Compiler, CMake, Git.

Prerequisites

• Clang, GCC, or another C compiler
• Git
• CMake

Installation

1. Clone the repo

   git clone https://github.com/DmitrTRC/dsfs.git

2. Create a build directory

   mkdir build

3. Run CMake

   cmake -H. -Bbuild

4. Build the project

   cd build
   make

(back to top)

Usage

Just run the executable file in the bin directory.

For more information, please refer to the Documentation

(back to top)

Roadmap

• Base infrastructure
• Virtual Drive
• File System
• File System Command Manager
• File System Interface

See the open issues for a full list of proposed features (and known issues) .

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Your Name - DmitrTRC - [e-mail], [e-mail]

Project Link: https://github.com/DmitrTRC/dsfs.git

(back to top)