Merge pull request #4 from BAMresearch/final_cleanup_add_hashlib

Final cleanup add hashlib

Author: JosePizarro3

.env.example

@@ -0,0 +1,13 @@
+# Application
+PROJECT_NAME=JSONed
+API_V1_STR=/api/v1
+
+# MongoDB
+MONGO_DATABASE=jsoned_db
+MONGO_DATABASE_URI=mongodb://localhost:27017
+COLLECTION=schemas
+
+# CORS (comma-separated or JSON list)
+BACKEND_CORS_ORIGINS=http://localhost,http://localhost:3000
+# or:
+# BACKEND_CORS_ORIGINS=["http://localhost","http://localhost:3000"]

.gitignore

@@ -1,3 +1,8 @@
+# added
+.MyNotes/
+.venv_jsoned
+
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[codz]
@@ -182,9 +187,9 @@ cython_debug/
 .abstra/
 
 # Visual Studio Code
-#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
 #  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
-#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  and can be added to the global gitignore or merged into this file. However, if you prefer,
 #  you could uncomment the following to ignore the entire vscode folder
 # .vscode/
 
@@ -205,3 +210,8 @@ cython_debug/
 marimo/_static/
 marimo/_lsp/
 __marimo__/
+
+# ignore dynamic version file
+_version.py
+# ignore VSCode launch configurations (debugging configurations which are user-specific)
+.vscode/launch.json

NOTICE

@@ -1,2 +1,60 @@
 # jsoned
-A full-stack application to visualize and edit entities and their relations defined in JSON Schema.
+
+A local application to visualize and edit entities and their relations defined in a JSON Schema. The architecture
+of `jsoned` is:
+
+- FastAPI (Python): backend
+- SvelteKit (JavaScript): frontend
+- MongoDB: database
+- Tauri (Rust): framework for building binaries for desktop app
+
+
+## Development
+
+If you want to develop locally this package, clone the project and enter in the workspace folder:
+
+```sh
+git clone https://github.com/BAMresearch/jsoned.git
+cd jsoned
+```
+
+Create a virtual environment (you can use Python>3.10) in your workspace:
+
+```sh
+python3 -m venv .venv
+source .venv/bin/activate
+```
+
+We recommend using [`uv`](https://docs.astral.sh/uv/) for installing the dependencies:
+
+```sh
+uv sync
+```
+
+### Run the app
+
+In order to run the app, you need to follow the instructions for different services. Using `uvicorn` you can launch the FastAPI app:
+
+```sh
+cd jsoned/
+uvicorn main:app --reload
+```
+
+The SwaggerUI will help you understand the implemented endpoints.
+
+#### MongoDB Compass
+
+Go to [MongoDB](https://www.mongodb.com/) and install [MongoDB Community Edition](https://www.mongodb.com/docs/manual/administration/install-community/?operating-system=linux&linux-distribution=ubuntu&linux-package=default&search-linux=with-search-linux) and [MongoDB Compass](https://www.mongodb.com/try/download/compass).
+
+Once the installation is finished, launch MongoDB Compass and start a connection with URI `mongodb://localhost:27017`. Name it `json_db`. You can also create a new collection and call it `schemas`. The URI and names of the database and collection are defined in `jsoned/settings.py`.
+
+#### NodeJS
+
+We use `npm` to manage the frontend dependencies. Go to [NodeJS](https://nodejs.org/en) and install `npm`.
+
+You can install and run the SvelteKit server:
+
+```sh
+cd gui/
+npm run dev
+```

README.md

@@ -0,0 +1,3 @@
+from fastapi import APIRouter
+
+api_router = APIRouter()

backend/datamodel.py

@@ -0,0 +1,8 @@
+from fastapi import APIRouter
+
+from jsoned.api.v1.endpoints import schemas
+
+api_router = APIRouter()
+api_router.include_router(schemas.router, prefix="/schemas", tags=["schemas"])
+# TODO add login with oauth2
+# api_router.include_router(login.router, prefix="/login", tags=["login"])