Skip to content

Commit

Permalink
setup basic structure
Browse files Browse the repository at this point in the history
  • Loading branch information
yibeichan committed Dec 18, 2023
1 parent fc364a5 commit 011e3ee
Show file tree
Hide file tree
Showing 6 changed files with 42 additions and 3 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.DS_Store

# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
Expand Down
6 changes: 3 additions & 3 deletions cookiecutter.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"protocol_name": "my-reproschema-protocol",
"__protocol_slug": "{{ cookiecutter.protocol_name|lower()|replace(' ', '_')|replace('-', '_') }}",
"github_org": "my-org",
"protocol_name": "my-reproschema-protocol",
"__protocol_slug": "{{ cookiecutter.protocol_name|lower()|replace(' ', '_')|replace('-', '_') }}",
"github_org": "my-org",
"__source_path": "src/{{cookiecutter.__protocol_slug}}/schema/{{cookiecutter.__project_slug}}.yaml",
"protocol_description": "This is the protocol description.",
"full_name": "My Name",
Expand Down
29 changes: 29 additions & 0 deletions {{cookiecutter.protocol_name}}/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# {{cookiecutter.protocol_name}}

{{cookiecutter.protocol_description}}

## Website

[https://{{cookiecutter.github_org}}.github.io/{{cookiecutter.protocol_name}}](https://{{cookiecutter.github_org}}.github.io/{{cookiecutter.protocol_name}})

## Repository Structure

* [{{cookiecutter.__protocol_slug}}/]({{cookiecutter.__protocol_slug}}/) - Contains protocol files
* [schema]({{cookiecutter.__protocol_slug}}/{{cookiecutter.__protocol_slug}}_schema) - Reproschema protocol schema (edit this file)
* [README.md]({{cookiecutter.__protocol_slug}}/README.md) - Welcome page of the protocol (edit this file)
* [activities/](activities/) - Contains activity files (edit these files)
* [ui-changes/src/config.js](ui-changes/src/config.js) - Source file for UI setup (edit this file)

## Developer Documentation

<details>
Use the `make` command to generate protocol artefacts:

* `make all`: make everything
* `make deploy`: deploys site
</details>

## Credits

This protocol was made with
[reproschema-protocol-cookiecutter](https://github.com/ReproNim/reproschema-protocol-cookiecutter).
8 changes: 8 additions & 0 deletions {{cookiecutter.protocol_name}}/ui-changes/src/config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
module.exports = {
/* eslint-disable */
githubSrc: 'https://raw.githubusercontent.com/{{cookiecutter.github_org}}/{{cookiecutter.protocol_name}}/main/{{cookiecutter.__protocol_slug}}/{{cookiecutter.__protocol_slug}}_schema',
banner: {{cookiecutter.protocol_description}},
startButton: 'Join',
assetsPublicPath: '/{{cookiecutter.__protocol_slug}}/',
backendServer: null
};
Empty file.

0 comments on commit 011e3ee

Please sign in to comment.