direct-webapp

KO | EN

gitlite — search

#javascript #python #hacktoberfest #ai #golang #go #linux #nodejs #macos #java #awesome #cli #pytorch #mcp

(★ 10)

The Digital Research Competencies (DIRECT) Framework helps classify and describe a wide range of technical and non-technical skills used across digital research roles.

direct-webapp Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# DIRECT Framework Webapp

[![GitHub](https://img.shields.io/github/license/direct-framework/direct-webapp)](https://raw.githubusercontent.com/direct-framework/direct-webapp/main/LICENSE)
[![Test and build](https://github.com/direct-framework/direct-webapp/actions/workflows/ci.yml/badge.svg)](https://github.com/direct-framework/direct-webapp/actions/workflows/ci.yml)
[![codecov](https://codecov.io/gh/direct-framework/direct-webapp/graph/badge.svg?token=56K64XN243)](https://codecov.io/gh/direct-framework/direct-webapp)
[![DOI](https://zenodo.org/badge/876231041.svg)](https://doi.org/10.5281/zenodo.19223448)

A Django webapp implementing the [DIRECT competencies framework](https://github.com/direct-framework/digital-research-competencies-framework/) as a website that can:

- Allow browsing of all the skills.
- Allow people to score their own skills and view their skill wheels.
- Display and link the professional development resources curated for each skill.

This Django project uses:

- [`pip-tools`] for packaging and dependency management.
- [`pre-commit`](https://pre-commit.com/) for various linting, formatting and static type checking. Pre-commit hooks are automatically kept updated with [pre-commit.ci](https://pre-commit.ci).
- [`pytest`](https://pytest.org/) and [GitHub Actions](https://github.com/features/actions).

[`pip-tools`] is chosen as a lightweight dependency manager that adheres to the [latest standards](https://peps.python.org/pep-0621/) using `pyproject.toml`.

## Related links

- [DIRECT framework](https://github.com/direct-framework/digital-research-competencies-framework#about)
- [History of the project - including competency wheels UI](https://github.com/direct-framework/digital-research-competencies-framework#history)
- [Skills and competencies - definitions](https://github.com/direct-framework/digital-research-competencies-framework#competency-framework)
- [Contributors](https://github.com/direct-framework/digital-research-competencies-framework#contributors)

## Current Status

- [x] Initial research
- [x] Initial development <-- We are here
- [x] Minimum viable product
- [x] Alpha release
- [ ] Feature-complete release

## Installation

You must have **Python version 3.12 or later** installed.

To get started:

1. Create and activate a [virtual environment](https://docs.python.org/3/library/venv.html):

```bash
   python -m venv .venv
   source .venv/bin/activate # with Powershell on Windows: `.venv\Scripts\Activate.ps1`
   ```

2. Install development requirements:

```bash
   pip install -r dev-requirements.txt
   ```

3. (Optionally) install tools for building documentation:

```bash
   pip install -r doc-requirements.txt
   ```

4. Install the git hooks:

```bash
   pre-commit install
   ```

5. First-time database setup:

Before running the server for the first time, initialise the database tables as follows:

```bash
   python manage.py migrate
   ```

If you run into the following error, then you've missed this step:

`django.db.utils.OperationalError: no such table: main_skilllevel`

6. Run the webapp:

```bash
   python manage.py runserver
   ```

When running the webapp for the first time you may get a warning similar to:

`You have 19 unapplied migration(s). Your project may not work properly until you apply the migrations for app(s): admin, auth, contenttypes, main, sessions.`

If this is the case, stop your webapp (with CONTROL-C) and apply the migrations with:

```bash
   python manage.py migrate
   ```

then restart it.

7. Run the tests:

```bash
   pytest
   ```

8. Create an admin account to access admin backend:

```bash
   python manage.py createsuperuser
   ```

9. Populate the database using a snapshot of v2.0 of the framework (this is not necessarily the latest live version, so this is only used for development).

```bash
   python manage.py loaddata direct_webapp/fixtures/framework-2-0.json
   ```

### Installation with Docker

The app can be run within a Docker container and a `docker-compose.yml` file is provided
to make this easy for development.

Requirements:

1. You have a modern version of [Docker](https://docs.docker.com/desktop/) installed.
2. You have a JSON version of the framework saved at `data/skills-competencies-framework.json`.

To launch the server run:

```bash
docker compose up
```

The app will be available at <http://127.0.0.1:8000/>

As above, create a superuser with

```bash
docker compose exec app python manage.py createsuperuser
```

The framework should be automatically loaded into the database.

## Updating Dependencies

To add or remove dependencies:

1. Edit the `dependencies` variables in the `pyproject.toml` file (aim to keep development tools separate from the project requirements).
2. Update the requirements files:
   - `pip-compile` for `requirements.txt` - the project requirements.
   - `pip-compile --extra dev -o dev-requirements.txt` for the development requirements.
   - `pip-compile --extra doc -o doc-requirements.txt` for the documentation tools.
3. Sync the files with your installation (install packages):
   - `pip-sync *requirements.txt`

To upgrade pinned versions, use the `--upgrade` flag with `pip-compile`.

Versions can be restricted from updating within the `pyproject.toml` using standard python package version specifiers, i.e. `"black<23"` or `"pip-tools!=6.12.2"`

[`pip-tools`]: https://pip-tools.readthedocs.io/en/latest/

## Frontend Node

This project includes an NPM-based setup for managing front-end assets like styles, scripts, and other resources. The `package.json` file contains predefined scripts to help with building and managing assets. You don't need to run these NPM commands if you are developing the Django app locally. You should only run these commands when needed, for example if you are changing javascript dependencies or modifying SCSS files.

See [Frontend Node](node/README.md) for details on working with the NPM-based frontend asset pipeline.

## Acknowledgements

_This work was supported by the [DisCouRSE Network+](https://discourse-network.github.io/), which received funding through the UKRI
Digital Research Infrastructure Programme_

## Contributors

<table>
 <tbody>
 <tr>
 <td align="center" valign="top" width="14.28%"><a href="http://horsfall.dev"><img src="https://avatars.githubusercontent.com/u/1079934?v=4?s=100" width="100px;" alt="Dave Horsfall"/> Dave Horsfall</a> <a href="#design-davehorsfall" title="Design">🎨</a> <a href="#code-davehorsfall" title="Code">💻</a> <a href="#projectManagement-davehorsfall" title="Project Management">📆</a> <a href="#maintenance-davehorsfall" title="Maintenance">🚧</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://github.com/AdrianDAlessandro"><img src="https://avatars.githubusercontent.com/u/40875798?v=4?s=100" width="100px;" alt="Adrian D'Alessandro"/> Adrian D'Alessandro</a> <a href="#design-AdrianDAlessandro" title="Design">🎨</a> <a href="#code-AdrianDAlessandro" title="Code">💻</a> <a href="#test-AdrianDAlessandro" title="Tests">⚠️</a> <a href="#maintenance-AdrianDAlessandro" title="Maintenance">🚧</a> <a href="#projectManagement-AdrianDAlessandro" title="Project Management">📆</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://github.com/TinyMarsh"><img src="https://avatars.githubusercontent.com/u/13540127?v=4?s=100" width="100px;" alt="Ryan"/> Ryan</a> <a href="#code-TinyMarsh" title="Code">💻</a> <a href="#infra-TinyMarsh" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="#tool-TinyMarsh" title="Tools">🔧</a> <a href="#maintenance-TinyMarsh" title="Maintenance">🚧</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://github.com/tdjames1"><img src="https://avatars.githubusercontent.com/u/10053102?v=4?s=100" width="100px;" alt="T D James"/> T D James</a> <a href="#code-tdjames1" title="Code">💻</a> <a href="#test-tdjames1" title="Tests">⚠️</a> <a href="#maintenance-tdjames1" title="Maintenance">🚧</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://github.com/connoraird"><img src="https://avatars.githubusercontent.com/u/61978554?v=4?s=100" width="100px;" alt="Connor Aird"/> Connor Aird</a> <a href="#code-connoraird" title="Code">💻</a> <a href="#test-connoraird" title="Tests">⚠️</a> <a href="#maintenance-connoraird" title="Maintenance">🚧</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://personalpages.manchester.ac.uk/staff/Andrew.Gait/"><img src="https://avatars.githubusercontent.com/u/13529420?v=4?s=100" width="100px;" alt="Andrew Gait"/> Andrew Gait</a> <a href="#ideas-andrewgait" title="Ideas, Planning, & Feedback">🤔</a> <a href="#code-andrewgait" title="Code">💻</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://brynnoelubald.com/"><img src="https://avatars.githubusercontent.com/u/55503826?v=4?s=100" width="100px;" alt="Bryn Noel Ubald"/> Bryn Noel Ubald</a> <a href="#tool-bnubald" title="Tools">🔧</a> <a href="#code-bnubald" title="Code">💻</a></td>
 </tr>
 <tr>
 <td align="center" valign="top" width="14.28%"><a href="https://github.com/jklebes"><img src="https://avatars.githubusercontent.com/u/11175421?v=4?s=100" width="100px;" alt="Jason Klebes"/> Jason Klebes</a> <a href="#bug-jklebes" title="Bug reports">🐛</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://github.com/sbland"><img src="https://avatars.githubusercontent.com/u/4863319?v=4?s=100" width="100px;" alt="sbland"/> sbland</a> <a href="#code-sbland" title="Code">💻</a> <a href="#design-sbland" title="Design">🎨</a> <a href="#ideas-sbland" title="Ideas, Planning, & Feedback">🤔</a> <a href="#maintenance-sbland" title="Maintenance">🚧</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://github.com/barneydobson"><img src="https://avatars.githubusercontent.com/u/29261471?v=4?s=100" width="100px;" alt="barneydobson"/> barneydobson</a> <a href="#code-barneydobson" title="Code">💻</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://github.com/anenadic/professional-cv"><img src="https://avatars.githubusercontent.com/u/631719?v=4?s=100" width="100px;" alt="Aleksandra Nenadic"/> Aleksandra Nenadic</a> <a href="#code-anenadic" title="Code">💻</a> <a href="#maintenance-anenadic" title="Maintenance">🚧</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://github.com/SaranjeetKaur"><img src="https://avatars.githubusercontent.com/u/28556616?v=4?s=100" width="100px;" alt="Saranjeet Kaur"/> Saranjeet Kaur</a> <a href="#maintenance-saranjeetkaur" title="Maintenance">🚧</a> <a href="#code-saranjeetkaur" title="Code">💻</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://github.com/apps/github-actions"><img src="https://avatars.githubusercontent.com/in/15368?v=4?s=100" width="100px;" alt="github-actions[bot]"/> github-actions[bot]</a> <a href="#maintenance-github-actions[bot]" title="Maintenance">🚧</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://github.com/apps/pre-commit-ci"><img src="https://avatars.githubusercontent.com/in/68672?v=4?s=100" width="100px;" alt="pre-commit-ci[bot]"/> pre-commit-ci[bot]</a> <a href="#code-pre-commit-ci[bot]" title="Code">💻</a></td>
 </tr>
 <tr>
 <td align="center" valign="top" width="14.28%"><a href="https://github.com/amangoel185"><img src="https://avatars.githubusercontent.com/u/10528392?v=4?s=100" width="100px;" alt="Aman Goel"/> Aman Goel</a> <a href="#maintenance-amangoel185" title="Maintenance">🚧</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://github.com/PhilReedData"><img src="https://avatars.githubusercontent.com/u/25770348?v=4?s=100" width="100px;" alt="Phil Reed"/> Phil Reed</a> <a href="#maintenance-philreeddata" title="Maintenance">🚧</a> <a href="#code-philreeddata" title="Code">💻</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://tbyhdgs.info"><img src="https://avatars.githubusercontent.com/u/9694524?v=4?s=100" width="100px;" alt="Toby Hodges"/> Toby Hodges</a> <a href="#code-tobyhodges" title="Code">💻</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://github.com/GeoDaoyu"><img src="https://avatars.githubusercontent.com/u/34641603?v=4?s=100" width="100px;" alt="geodaoyu"/> geodaoyu</a> <a href="#code-geodaoyu" title="Code">💻</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://github.com/cc-a"><img src="https://avatars.githubusercontent.com/u/16690296?v=4?s=100" width="100px;" alt="Christopher Cave-Ayland"/> Christopher Cave-Ayland</a> <a href="#maintenance-cc-a" title="Maintenance">🚧</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://github.com/Sahil590"><img src="https://avatars.githubusercontent.com/u/56438860?v=4?s=100" width="100px;" alt="Sahil Raja"/> Sahil Raja</a> <a href="#maintenance-sahil590" title="Maintenance">🚧</a> <a href="#test-sahil590" title="Tests">⚠️</a> <a href="#code-sahil590" title="Code">💻</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://github.com/Max-Gamill"><img src="https://avatars.githubusercontent.com/u/91465918?v=4?s=100" width="100px;" alt="Max Gamill"/> Max Gamill</a> <a href="#code-max-gamill" title="Code">💻</a></td>
 </tr>
 <tr>
 <td align="center" valign="top" width="14.28%"><a href="http://kevinrue.github.io/"><img src="https://avatars.githubusercontent.com/u/5769108?v=4?s=100" width="100px;" alt="Kevin Rue-Albrecht"/> Kevin Rue-Albrecht</a> <a href="#code-kevinrue" title="Code">💻</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://github.com/mjademitchell"><img src="https://avatars.githubusercontent.com/u/242165951?v=4?s=100" width="100px;" alt="mjademitchell"/> mjademitchell</a> <a href="#code-mjademitchell" title="Code">💻</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://github.com/elichad"><img src="https://avatars.githubusercontent.com/u/20683271?v=4?s=100" width="100px;" alt="Eli Chadwick"/> Eli Chadwick</a> <a href="#code-elichad" title="Code">💻</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://github.com/ens-lgil"><img src="https://avatars.githubusercontent.com/u/6085223?v=4?s=100" width="100px;" alt="Laurent Gil"/> Laurent Gil</a> <a href="#code-ens-lgil" title="Code">💻</a></td>
 </tr>
 </tbody>
</table>

direct-webapp

direct-webapp Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

direct-webapp

direct-webapp Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README