readme

README.MD

@@ -1,3 +1,78 @@
 # RDFCraft
 
-TBD
+RDFCraft is a tool for mapping csv/json data to RDF with an easy to use GUI. It
+uses FastAPI for the backend, React for the frontend and everything packed in a
+single executable using Nuitka.
+
+![RDFCraft Mapping Interface](./imgs/1.png)
+
+## Features 🌟
+
+- **Easy to use GUI**: Just upload your csv/json file and start mapping your
+  data to RDF.
+
+- **Ontology Indexing**: It indexes all the classes and properties from the
+  provided ontology and provides recommendations while mapping.
+
+- **Source Indexing**: It indexes all the columns from the provided csv/json
+  file and provides recommendations while mapping.
+
+- **Auto Completion**: It provides auto completion while creating URIs for
+  entities.
+
+- **Multiple file formats**: Supports both csv and json file formats.
+
+- **Multiple RML formats**: It generates both YARRRML and RML mappings.
+
+## Installation 🚀
+
+From Releases page, download the latest release for your OS and extract the
+contents. Run the executable and you are good to go.
+
+> [!IMPORTANT] On macOS, because app is not notarized by Apple, you need to run
+> following command to bypass the gatekeeper:
+>
+> ```bash
+> xattr -rd com.apple.quarantine </path/to/RDFCraft.app>
+> ```
+>
+> More information about gatekeeper can be found
+> [here](https://support.apple.com/en-us/HT202491).
+
+## Development 🛠
+
+1- Clone the repository:
+
+```bash
+git clone [email protected]:MaastrichtU-IDS/RDFCraft.git
+```
+
+2- Install the dependencies for the backend:
+
+- If you have `just` installed:
+
+```bash
+just install-dev
+```
+
+- Otherwise:
+
+```bash
+uv sync --all-extras --dev
+```
+
+3- Install the dependencies for the frontend:
+
+```bash
+cd app
+npm install
+```
+
+4- Start the backend
+
+5- Start the frontend
+
+```bash
+cd app
+npm run dev
+```