sophon/README.md

<div align="center">

# Sophon

Research hub for universities

</div>

> [!Danger]
> This project is not currently being maintained due to a sudden lack of external interest.

## Links

[![On ACM Digital Library](https://img.shields.io/badge/acm%20digital%20library-open%20access-b95709)](https://dl.acm.org/doi/abs/10.1145/3491418.3535163)


## Goal

The goal of this project is developing a platform that universities can use to **host** and **share** their _datasets_, _research projects_ and resulting _papers_.


## Screenshots

![Screenshot 1](https://user-images.githubusercontent.com/1540885/138204295-59c6efc3-a4fe-4c91-982b-8257e42b7970.png)

![Screenshot 2](https://user-images.githubusercontent.com/1540885/138204345-346d144f-914f-4435-8816-69abe4a34381.png)

![Screenshot 3](https://user-images.githubusercontent.com/1540885/138204387-69cd2e63-3030-48b8-a149-043e3e2393f7.png)


## Installation

### Requirements

- Internet connection
- Any Linux server
- [Docker][what-is-docker]
- [Docker Compose][what-is-compose]

[what-is-docker]: https://www.docker.com/

[what-is-compose]: https://docs.docker.com/compose/


### Steps

1. Create a new directory named `sophon` on your machine and enter it:
   ```console
   # mkdir sophon
   # cd sophon
   ```

2. Pull the `ghcr.io/steffo99/sophon-jupyter` Docker image:
   ```console
   # docker pull ghcr.io/steffo99/sophon-jupyter
   ```

3. Download the `docker-compose.yml` file from this repository:
   ```console
   # wget "https://raw.githubusercontent.com/Steffo99/sophon/main/docker-compose.yml"
   ```

4. Configure the `docker-compose.yml` file following the instructions written in the comments:
   ```console
   # vim docker-compose.yml
   ```

5. Start the Docker containers:
   ```console
   # docker compose up -d
   ```


## Structure

The project consists of four parts:

- a **single-page-app** built with [React][what-is-react] (`/frontend`);
- a **web API** built with [Django Rest Framework][what-is-drf] (`/backend`);
- a **dynamic proxy** implemented on the [Apache HTTP Server][what-is-httpd] (`/proxy`);
- a **Docker image** containing a single instance of [JupyterLab][what-is-jupyterlab] (`/jupyter`)

[what-is-react]: https://reactjs.org/

[what-is-drf]: https://www.django-rest-framework.org/

[what-is-httpd]: https://httpd.apache.org/

[what-is-jupyterlab]: https://jupyter.org/

For more details on the underlying libraries, packages, modules and plugins used, see the following files:

- [`/frontend/package.json`][lib-frontend]
- [`/backend/pyproject.toml`][lib-backend]
- [`/proxy/httpd.conf`][lib-proxy]
- [`/jupyter/Dockerfile`][lib-jupyter]

[lib-frontend]: https://github.com/Steffo99/sophon/blob/main/frontend/package.json

[lib-backend]: https://github.com/Steffo99/sophon/blob/main/backend/pyproject.toml

[lib-proxy]: https://github.com/Steffo99/sophon/blob/main/proxy/httpd.conf

[lib-jupyter]: https://github.com/Steffo99/sophon/blob/main/jupyter/Dockerfile


## Development

### Progress

Development progress is tracked on issues [#20][issue-#20] and [#67][issue-#67].  
Also see the [issue tracker][issue-tracker].

[issue-#20]: https://github.com/Steffo99/sophon/issues/20

[issue-#67]: https://github.com/Steffo99/sophon/issues/67

[issue-tracker]: https://github.com/Steffo99/sophon/issues


### Tools

Sophon is developed using [IntelliJ IDEA Ultimate][what-is-idea].

Metadata is included in the `/.idea` directory so that code style and run configuration are consistent across all machines used during the development.

Run configurations for *running the backend*, *testing the backend*, *running the frontend* and *testing the frontend* are included.

[what-is-idea]: https://www.jetbrains.com/idea/


### Commits

Commits names are prefixed with a variant of [Gitmoji][what-is-gitmoji] which follows roughly this legend:

- ✨ New feature
- 🔧 Refactor or tweak
- 🐛 Bug fix
- 🧹 Cleanup
- 📔 Documentation
- 🎓 Thesis
- 🗒 Readme
- ⬆ Dependency update
- 📦 Packaging
- 🔨 Tool update
- 🚧 Work in progress
- 🔀 Merge

[what-is-gitmoji]: https://gitmoji.dev/


### Continuous Deployment (CD)

Sophon uses [GitHub Actions][what-is-github-actions] and [Vercel][what-is-vercel] for Continuous Deployment.

[what-is-vercel]: https://vercel.com/

[what-is-github-actions]: https://docs.github.com/en/actions

Docker images for the frontend, backend, proxy and jupyterlab are built by GitHub Actions **on each push to the `main` branch** of this repository,
and [automatically published][list-containers] to the [GitHub Container Registry][what-is-github-containers]

[list-containers]: https://github.com/Steffo99?tab=packages&repo_name=sophon

[what-is-github-containers]: https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry

A generic version of the frontend is build automatically by Vercel **on each push to the `main` branch** and **on every pull request** to this repository, and
automatically published to the [sophon.steffo.eu](https://sophon.steffo.eu) domain.


### Releases

Releases are created on each milestone and are available on the [Releases page][list-releases].

[list-releases]: https://github.com/Steffo99/sophon/releases


## People

The project is developed by [Stefano Pigozzi][who-is-stefano-pigozzi] for [Università degli studi di Modena e Reggio Emilia][what-is-unimore].

[who-is-stefano-pigozzi]: https://steffo.eu

[what-is-unimore]: https://www.unimore.it/
Update README 2024-09-17 01:21:57 +00:00			`<div align="center">`

🧹 Reorganize project to make space for the frontend 2021-04-16 16:00:19 +00:00			`# Sophon`
✨ Add README.md 2021-04-03 13:43:34 +00:00
Update README 2024-09-17 01:21:57 +00:00			`Research hub for universities`
🗒 Add a better README 2021-08-03 01:17:31 +00:00
Update README 2024-09-17 01:21:57 +00:00			`</div>`
Add screenshots 2021-10-21 03:04:37 +00:00
Update README 2024-09-17 01:21:57 +00:00			`> [!Danger]`
			`> This project is not currently being maintained due to a sudden lack of external interest.`
Add screenshots 2021-10-21 03:04:37 +00:00
Update README 2024-09-17 01:21:57 +00:00			`## Links`

			`[![On ACM Digital Library](https://img.shields.io/badge/acm%20digital%20library-open%20access-b95709)](https://dl.acm.org/doi/abs/10.1145/3491418.3535163)`
Add screenshots 2021-10-21 03:04:37 +00:00
🗒 Improve README.md 2021-10-21 01:57:30 +00:00
🗒 Add a better README 2021-08-03 01:17:31 +00:00			`## Goal`

Update README.md 2022-01-03 17:42:14 +00:00			`The goal of this project is developing a platform that universities can use to host and share their _datasets_, _research projects_ and resulting _papers_.`
🗒 Add a better README 2021-08-03 01:17:31 +00:00
🗒 Improve README.md 2021-10-21 01:57:30 +00:00
Update README 2024-09-17 01:21:57 +00:00			`## Screenshots`

			`![Screenshot 1](https://user-images.githubusercontent.com/1540885/138204295-59c6efc3-a4fe-4c91-982b-8257e42b7970.png)`

			`![Screenshot 2](https://user-images.githubusercontent.com/1540885/138204345-346d144f-914f-4435-8816-69abe4a34381.png)`

			`![Screenshot 3](https://user-images.githubusercontent.com/1540885/138204387-69cd2e63-3030-48b8-a149-043e3e2393f7.png)`


🗒 Add install steps (closes #58) 2021-10-21 03:00:09 +00:00			`## Installation`

			`### Requirements`

			`- Internet connection`
			`- Any Linux server`
			`- [Docker][what-is-docker]`
			`- [Docker Compose][what-is-compose]`

			`[what-is-docker]: https://www.docker.com/`

🗒 Fix broken link 2021-10-21 03:02:50 +00:00			`[what-is-compose]: https://docs.docker.com/compose/`
🗒 Add install steps (closes #58) 2021-10-21 03:00:09 +00:00

			`### Steps`

			1. Create a new directory named `sophon` on your machine and enter it:
			```console
			`# mkdir sophon`
			`# cd sophon`
			```

			2. Pull the `ghcr.io/steffo99/sophon-jupyter` Docker image:
			```console
			`# docker pull ghcr.io/steffo99/sophon-jupyter`
			```

			3. Download the `docker-compose.yml` file from this repository:
			```console
			`# wget "https://raw.githubusercontent.com/Steffo99/sophon/main/docker-compose.yml"`
			```

			4. Configure the `docker-compose.yml` file following the instructions written in the comments:
			```console
			`# vim docker-compose.yml`
			```

			`5. Start the Docker containers:`
			```console
			`# docker compose up -d`
			```


🗒 Improve even more README.md 2021-10-21 02:23:03 +00:00			`## Structure`
🗒 Add a better README 2021-08-03 01:17:31 +00:00
🗒 Improve README.md 2021-10-21 01:57:30 +00:00			`The project consists of four parts:`

🗒 Improve even more README.md 2021-10-21 02:23:03 +00:00			- a single-page-app built with [React][what-is-react] (`/frontend`);
			- a web API built with [Django Rest Framework][what-is-drf] (`/backend`);
			- a dynamic proxy implemented on the [Apache HTTP Server][what-is-httpd] (`/proxy`);
			- a Docker image containing a single instance of [JupyterLab][what-is-jupyterlab] (`/jupyter`)

			`[what-is-react]: https://reactjs.org/`

			`[what-is-drf]: https://www.django-rest-framework.org/`

			`[what-is-httpd]: https://httpd.apache.org/`
🗒 Improve README.md 2021-10-21 01:57:30 +00:00
🗒 Improve even more README.md 2021-10-21 02:23:03 +00:00			`[what-is-jupyterlab]: https://jupyter.org/`
🗒 Improve README.md 2021-10-21 01:57:30 +00:00
			`For more details on the underlying libraries, packages, modules and plugins used, see the following files:`

			- [`/frontend/package.json`][lib-frontend]
			- [`/backend/pyproject.toml`][lib-backend]
			- [`/proxy/httpd.conf`][lib-proxy]
			- [`/jupyter/Dockerfile`][lib-jupyter]

			`[lib-frontend]: https://github.com/Steffo99/sophon/blob/main/frontend/package.json`
🗒 Improve even more README.md 2021-10-21 02:23:03 +00:00
🗒 Improve README.md 2021-10-21 01:57:30 +00:00			`[lib-backend]: https://github.com/Steffo99/sophon/blob/main/backend/pyproject.toml`
🗒 Improve even more README.md 2021-10-21 02:23:03 +00:00
🗒 Improve README.md 2021-10-21 01:57:30 +00:00			`[lib-proxy]: https://github.com/Steffo99/sophon/blob/main/proxy/httpd.conf`
🗒 Improve even more README.md 2021-10-21 02:23:03 +00:00
🗒 Improve README.md 2021-10-21 01:57:30 +00:00			`[lib-jupyter]: https://github.com/Steffo99/sophon/blob/main/jupyter/Dockerfile`

🗒 Add a better README 2021-08-03 01:17:31 +00:00
🗒 Improve even more README.md 2021-10-21 02:23:03 +00:00			`## Development`

🗒 Add a better README 2021-08-03 01:17:31 +00:00			`### Progress`

🗒 Improve even more README.md 2021-10-21 02:23:03 +00:00			`Development progress is tracked on issues [#20][issue-#20] and [#67][issue-#67].`
			`Also see the [issue tracker][issue-tracker].`

			`[issue-#20]: https://github.com/Steffo99/sophon/issues/20`

			`[issue-#67]: https://github.com/Steffo99/sophon/issues/67`

			`[issue-tracker]: https://github.com/Steffo99/sophon/issues`
🗒 Add a better README 2021-08-03 01:17:31 +00:00
🗒 Improve README.md 2021-10-21 01:57:30 +00:00
🗒 Add a better README 2021-08-03 01:17:31 +00:00			`### Tools`

🗒 Improve even more README.md 2021-10-21 02:23:03 +00:00			`Sophon is developed using [IntelliJ IDEA Ultimate][what-is-idea].`
🗒 Add a better README 2021-08-03 01:17:31 +00:00
🗒 Improve even more README.md 2021-10-21 02:23:03 +00:00			Metadata is included in the `/.idea` directory so that code style and run configuration are consistent across all machines used during the development.

			`Run configurations for running the backend, testing the backend, running the frontend and testing the frontend are included.`

			`[what-is-idea]: https://www.jetbrains.com/idea/`
✨ Implement Notebook app (#65) * ✨ Start notebooks app * 🔧 Fix nullable fields for notebooks * 🔧 Display user-friendly name for `Notebook`s * 🔧 Allow filtering in the notebook admin page * 🗒 Improve README * 🗒 Improve README again * ⬆ Add bluelib to the dependencies of the frontend * 🧹 Prepare a good frontend base for development * ✨ Port and improve useStorageState Original: https://github.com/pds-nest/nest/blob/main/nest_frontend/hooks/useLocalStorageState.js * 🧹 Remove React logo * ⬆ Add `docker` to the dependencies * ⬆ Add `axios` to the dependencies * 🔨 Mark `src` as sources root * ✨ Add API routes to view Notebooks * 🔧 Use a router for the `by-project` route * 🐛 Fix deletion failing on `SophonViewSet` * 🔧 Abstract notebook methods * ✨ Create a base docker client * 🚧 Proof of concept for notebook starter * 📔 Document the contents of the Django apps * 🚧 Incomplete container implementation * 🚧 Working container implementation * 💥 Leftovers from an experiment * ✨ Correct implementation of the proxy configuration (Apache config file is still missing) * 💥 Improve code * 💥 Improve more things * 🔧 Remove duplicated `/project` in project app urls * ✨ Add basic Apache proxy config file * 🔧 User should have sudo access on the notebook * ✨ Implement the Internet access field (currently ignored) * 🧹 Cleanup code 2021-09-08 16:05:01 +00:00
🗒 Improve README.md 2021-10-21 01:57:30 +00:00
🗒 Add a better README 2021-08-03 01:17:31 +00:00			`### Commits`

🗒 Improve even more README.md 2021-10-21 02:23:03 +00:00			`Commits names are prefixed with a variant of [Gitmoji][what-is-gitmoji] which follows roughly this legend:`
🗒 Add a better README 2021-08-03 01:17:31 +00:00
			`- ✨ New feature`
			`- 🔧 Refactor or tweak`
			`- 🐛 Bug fix`
			`- 🧹 Cleanup`
			`- 📔 Documentation`
🗒 Add icon for thesis in Gitmoji legend 2021-11-21 14:55:07 +00:00			`- 🎓 Thesis`
🗒 Add a better README 2021-08-03 01:17:31 +00:00			`- 🗒 Readme`
			`- ⬆ Dependency update`
			`- 📦 Packaging`
			`- 🔨 Tool update`
			`- 🚧 Work in progress`
🗒 Improve even more README.md 2021-10-21 02:23:03 +00:00			`- 🔀 Merge`

			`[what-is-gitmoji]: https://gitmoji.dev/`


			`### Continuous Deployment (CD)`

			`Sophon uses [GitHub Actions][what-is-github-actions] and [Vercel][what-is-vercel] for Continuous Deployment.`

			`[what-is-vercel]: https://vercel.com/`

			`[what-is-github-actions]: https://docs.github.com/en/actions`

			Docker images for the frontend, backend, proxy and jupyterlab are built by GitHub Actions on each push to the `main` branch of this repository,
			`and [automatically published][list-containers] to the [GitHub Container Registry][what-is-github-containers]`

			`[list-containers]: https://github.com/Steffo99?tab=packages&repo_name=sophon`

			`[what-is-github-containers]: https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry`

			A generic version of the frontend is build automatically by Vercel on each push to the `main` branch and on every pull request to this repository, and
			`automatically published to the [sophon.steffo.eu](https://sophon.steffo.eu) domain.`


			`### Releases`

			`Releases are created on each milestone and are available on the [Releases page][list-releases].`

			`[list-releases]: https://github.com/Steffo99/sophon/releases`


			`## People`
🗒 Add a better README 2021-08-03 01:17:31 +00:00
🗒 Improve even more README.md 2021-10-21 02:23:03 +00:00			`The project is developed by [Stefano Pigozzi][who-is-stefano-pigozzi] for [Università degli studi di Modena e Reggio Emilia][what-is-unimore].`
🗒 Improve README.md 2021-10-21 01:57:30 +00:00
🗒 Improve even more README.md 2021-10-21 02:23:03 +00:00			`[who-is-stefano-pigozzi]: https://steffo.eu`
🗒 Add a better README 2021-08-03 01:17:31 +00:00
🗒 Improve even more README.md 2021-10-21 02:23:03 +00:00			`[what-is-unimore]: https://www.unimore.it/`