Skip to content

Commit c9e357e

Browse files
Merge pull request #6 from tucca-cellag/development
docs: add README.md for TUCCA Bioinformatics project
2 parents a4fb8e1 + b41c923 commit c9e357e

3 files changed

Lines changed: 173 additions & 0 deletions

File tree

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# TUCCA Bioinformatics Docs
2+
3+
This repository contains the source code for the **Tufts University Center for Cellular Agriculture (TUCCA) Bioinformatics** documentation site.
4+
5+
It hosts:
6+
- Documentation for the `tucca-rna-seq` workflow
7+
- Case studies
8+
- Learning materials and resources
9+
10+
## Access the Site
11+
12+
The live site is available at: **[https://tucca-cellag.github.io/](https://tucca-cellag.github.io/)**
13+
14+
## Repository Structure
15+
16+
The Docusaurus website source code is located in the [`tucca-cellag`](./tucca-cellag) directory.
17+
18+
- [`tucca-cellag/docs`](./tucca-cellag/docs): Markdown documentation files.
19+
- [`tucca-cellag/docusaurus.config.ts`](./tucca-cellag/docusaurus.config.ts): Site configuration.
20+
- [`tucca-cellag/src`](./tucca-cellag/src): React components and pages.
21+
22+
## Development
23+
24+
To run the website locally, navigate to the `tucca-cellag` directory:
25+
26+
```bash
27+
cd tucca-cellag
28+
npm install
29+
npm start
30+
```

tucca-cellag/package-lock.json

Lines changed: 141 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

tucca-cellag/package.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@
1717
"dependencies": {
1818
"@docusaurus/core": "^3.9.2",
1919
"@docusaurus/preset-classic": "^3.9.2",
20+
"@emotion/react": "^11.14.0",
21+
"@emotion/styled": "^11.14.1",
2022
"@mdx-js/react": "^3.1.1",
2123
"@mui/icons-material": "^7.3.5",
2224
"@mui/material": "^7.3.5",

0 commit comments

Comments
 (0)