Page MenuHomeSoftware Heritage
Files F8393667

README.md
No OneTemporary
Actions

README.md
View Options

# Codemeta Generator
This repository contains a (client-side) web application to generate
CodeMeta documents (aka. `codemeta.json`).
The [CodeMeta initiative](https://github.com/codemeta/codemeta) is a Free and Open Source academic collaboration
creating a minimal metadata schema for research software and code.
The academic community recommands on adding a codemeta.json file in
the root directory of your repository.
With this linked data metadata file, you can easily declare the authorship,
include contextual information and link to other research outputs (publications,
data, etc.).
Also, the `codemeta.json` file in your source code is indexed in the
Software Heritage (SWH) archive, which will improve findability in searches.
### References
- [SWH guidelines](https://www.softwareheritage.org/save-and-reference-research-software/) for research software.
- [SWH blog post](https://www.softwareheritage.org/2019/05/28/mining-software-metadata-for-80-m-projects-and-even-more/) about metadata indexation.
- [Dan S. Katz's blog post](https://danielskatzblog.wordpress.com/2017/09/25/software-heritage-and-repository-metadata-a-software-citation-solution/) about including
metadata in your repository.
- FORCE11's Software Citation Implementation WG [repository](https://github.com/force11/force11-sciwg)
- RDA & FORCE11's joint Software Source Code Identification WG
[repository](https://github.com/force11/force11-rda-scidwg)
## Specifications
### Use case
1. create a complete codemeta.json file from scratch
2. aggregate existing information and add complementary information to
a codemeta.json file
### Functionalities
- helpers while completing the form, for example a reference list of spdx
licenses
- a validation mechanism after submission
- the possibility to use all the codeMeta terms and schema.org terms
- accessible from multiple platforms (web browsers or OS)
- (extra) the possibility to correct the output after validation as part
of the creation process
This tool was initially prepared for the [FORCE19 Hackathon](https://github.com/force11/force11-rda-scidwg/tree/master/hackathon/FORCE2019).
**NB:** codemeta v2.0 is generated by default, but v3.0 (v2.0 compatible) can be generated via a dedicated button.
## Code contributions.
This section only applies to developers who want to contribute to the Codemeta Generator.
If you only want to use it, you can use
[the hosted version](https://codemeta.github.io/codemeta-generator/) instead.
### Code guidelines
This application is designed to work on popular modern browsers (Firefox,
Chromium/Google Chrome, Edge, Safari). Check [Caniuse](https://caniuse.com/)
for availability of features for these browsers.
To keep the architecture simple, we serve javascript files directly to
browsers, without a compiler or transpiler.
### Running local changes
To run Codemeta Generator, you just need an HTTP server serving the
files (nginx, apache2, etc.).
The simplest way is probably to use Python's HTTP server:
```
git clone https://github.com/codemeta/codemeta-generator
cd codemeta-generator
python3 -m http.server
```
then open [http://localhost:8000/](http://localhost:8000/) in your web browser.
### Automatic testing
In addition to manual testing, we have automated tests to check for bugs
quickly, using [Cypress](https://www.cypress.io/).
To run them, first install Cypress:
```
sudo apt install npm # or the equivalent on your system
npx cypress@9.7.0 install
```
Then, run the tests:
```
npx cypress@9.7.0 run
```
## Contributed by
![Image description](https://annex.softwareheritage.org/public/logo/software-heritage-logo-title-motto.svg)

File Metadata

Mime Type
text/plain
Expires
Wed, Jun 4, 7:16 PM (3 d, 11 h ago)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
3238767

Event Timeline

About · Developer information · Legal