{"id":24951244,"url":"https://github.com/without-eyes/wsfs","last_synced_at":"2026-04-29T13:35:15.246Z","repository":{"id":273061167,"uuid":"918593295","full_name":"without-eyes/wsfs","owner":"without-eyes","description":"RAM-based File System","archived":false,"fork":false,"pushed_at":"2025-02-23T09:08:01.000Z","size":231,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-23T10:19:28.023Z","etag":null,"topics":["c","c-programming","c-programming-language","c-project","c11","console-ui","doxyfile","doxygen","doxygen-documentation","file-system","filesystem","fs","ramfs"],"latest_commit_sha":null,"homepage":"","language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/without-eyes.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-01-18T10:46:59.000Z","updated_at":"2025-02-23T09:08:04.000Z","dependencies_parsed_at":"2025-02-05T23:26:22.286Z","dependency_job_id":"90fa5c3c-28dc-4dd7-957c-4fed9feacf4b","html_url":"https://github.com/without-eyes/wsfs","commit_stats":null,"previous_names":["without-eyes/ramfs","without-eyes/wsfs"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/without-eyes%2Fwsfs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/without-eyes%2Fwsfs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/without-eyes%2Fwsfs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/without-eyes%2Fwsfs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/without-eyes","download_url":"https://codeload.github.com/without-eyes/wsfs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246088473,"owners_count":20721694,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["c","c-programming","c-programming-language","c-project","c11","console-ui","doxyfile","doxygen","doxygen-documentation","file-system","filesystem","fs","ramfs"],"created_at":"2025-02-03T00:08:31.400Z","updated_at":"2026-04-29T13:35:10.226Z","avatar_url":"https://github.com/without-eyes.png","language":"C","funding_links":[],"categories":[],"sub_categories":[],"readme":"# WSFS - Without eyeS's File System\n\n## Overview\n\nWSFS is a RAM-based file system written in C. It has writing/reading files, directories, and symbolic links using a hierarchical node-based system.\nThis project also has simple CLI program to test file system's functions. \n\n## Features\n\n- System is a tree that has a single-linked list as a child.\n- Path resolution to retrieve full paths of files.\n- Recursive file search.\n\n## Example diagram\n\n![Schematic diagram](diagram.png?)\n\n## Installation\n\n```sh\n# Clone the repository\ngit clone https://github.com/without-eyes/wsfs.git\ncd wsfs\n\n# Generate documentation (located in ./docs/)\nsudo apt-get install doxygen doxygen-gui graphviz\nmake doxygen\n\n# Compile shared library\nmake\n\n# Or if you want to use CLI program\nmake ui\n```\n\n## Usage\n\n```sh\n# Use WSFS library\ngcc $(PROG_SOURCES) -L$(LIBDIR) -Wl,-rpath=$(LIBDIR) -lwsfs $(CFLAGS) $(MACROS) -o $(PROG_NAME)\n```\nwhere:\n- PROG_SOURCES - your program source files\n- LIBDIR - location of libwsfs.so file\n- CFLAGS - gcc environment variables\n- MACROS - set macros(MAX_MEMORY_SIZE, MAX_FILE_COUNT, PERMISSION_MASK, MAX_NAME_SIZE,\n  BUFFER_SIZE, END_OF_FILE_LINE)\n- PROG_NAME - name of executable\n\n### Example:\n```\ngcc ./src/main.c -L . -Wl,-rpath=. -lwsfs -Wall -I ./CLIIDIR/ -DMAX_FILE_COUNT=100 -DPERMISSION_MASK=4 -o test\n```\n\n### Commands:\n\n- `q` - Quit\n- `f` - Create a file\n- `d` - Create a directory\n- `s` - Create a symbolic link\n- `x` - Chnage node's permissions\n- `c` - Change node's name\n- `e` - Delete (erase) file node\n- `w` - Write into file\n- `r` - Read from file\n- `g` - Go into child directory\n- `m` - Move file node to new location\n- `p` - Get the path of the file node\n- `b` - Go back into the parent directory\n\n## Code Structure\n\n```\nwsfs/\n│── library/\n│   │── src/\n│   │   ├── file_node_funcs.c     # File system structs and enums\n│   |   ├── file_node_structs.c   # File system functions\n│   |   ├── wsfs.c                # File system functions\n|   │\n|   │── include/\n|   │   ├── file_structs.h        # File node structures and functions\n|   |   ├── wsfs.h                # File system functions\n│   |\n|   │── test/\n|   │   ├── file_structs_test.h   # Unit tests for \n|   |   ├── wsfs_test.h           # User interface functions\n│\n│── cli/\n│   │── src/\n│   │   ├── main.c                # Entry point\n│   |   ├── ui.c                  # User interface functions\n|   │\n|   │── include/\n|   |   ├── ui.h                  # User interface functions\n|\n│── docs/                     # Documentation location\n|\n│── makefile                  # Build system\n│── README.md                 # Project overview\n```\n\n## Example\n\n```sh\ndrw-     50 2025-02-27 17:33 \\\nInput command('h' for help): f\nEnter file name: fi\n\ndrw-    101 2025-02-27 17:33 \\\nfrw-     51 2025-02-27 17:33 fi\nInput command('h' for help): q\n```\n\n## Debugging\n\nUse `gdb` for debugging:\n\n```sh\ngdb ./wsfs\n```\n\nSet breakpoints and run step-by-step debugging.\n\n## Contributing\n\nContributions are welcome! Follow these steps to contribute:\n\n1. **Read [Contribution guide](CONTRIBUTING.md)** before contributting.\n2. **Fork the repository** on GitHub.\n3. **Clone your fork** locally:\n   ```sh\n   git clone https://github.com/without-eyes/wsfs.git\n   cd wsfs\n   ```\n4. **Create a new branch** for your changes:\n   ```sh\n   git checkout -b my-feature-branch\n   ```\n5. **Make your changes** and commit:\n   ```sh\n   git add .\n   git commit -m \"Description of changes\"\n   ```\n6. **Push your changes** to GitHub:\n   ```sh\n   git push origin my-feature-branch\n   ```\n7. **Submit a Pull Request** via GitHub.\n\nMake sure to follow the project's coding style and include necessary documentation for your changes.\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwithout-eyes%2Fwsfs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwithout-eyes%2Fwsfs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwithout-eyes%2Fwsfs/lists"}