Skip to content

Commit 9220035

Browse files
rmdochertyrmdocherty
authored
Merge pull request #6 from tldr-group/rd/revamp
Rd/revamp
2 parents 2a79d1c + 9a0eb05 commit 9220035

File tree

110 files changed

+3087
-19997
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

110 files changed

+3087
-19997
lines changed

‎.github/workflows/build_deploy.yml‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
name: Deploy to GitHub Pages
2+
3+
on:
4+
push:
5+
branches: ["main"] # Triggers on merge/push to main
6+
7+
permissions:
8+
contents: read
9+
pages: write # Required to deploy to Pages
10+
id-token: write # Required for authentication
11+
12+
jobs:
13+
build:
14+
runs-on: ubuntu-latest
15+
steps:
16+
- name: Checkout
17+
uses: actions/checkout@v4
18+
19+
- name: Set up Node
20+
uses: actions/setup-node@v4
21+
with:
22+
node-version: "24"
23+
24+
- name: Install yarn
25+
run: npm install --global yarn
26+
27+
- name: Install dependencies
28+
run: yarn install
29+
30+
- name: Setup Pages
31+
uses: actions/configure-pages@v4
32+
33+
- name: Build
34+
run: yarn build # Replace with your actual build command
35+
36+
- name: Upload artifact
37+
uses: actions/upload-pages-artifact@v3
38+
with:
39+
path: "./dist" # Point this to your build output folder (e.g., './dist')
40+
41+
deploy:
42+
needs: build # This 'imports' the result of the build job
43+
runs-on: ubuntu-latest
44+
environment:
45+
name: github-pages
46+
url: ${{ steps.deployment.outputs.page_url }}
47+
steps:
48+
- name: Deploy to GitHub Pages
49+
id: deployment
50+
uses: actions/deploy-pages@v4

‎.gitignore‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,3 +21,7 @@
2121
npm-debug.log*
2222
yarn-debug.log*
2323
yarn-error.log*
24+
25+
old
26+
27+
dist/

‎README.md‎

Lines changed: 49 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,54 @@
11
![logo](/src/assets/logo-bright.svg)
2+
23
# Tools for Learning, Design and Research
34

45
This repository is for the tldr group website
56

6-
The website can be found [here](https://tldr-group.github.io/)
7+
The website can be found [here](https://tldr-group.github.io/)
8+
9+
## Content Management:
10+
11+
This repo has been written such that to add new content (publicatons, projects, team members), only the corresponding `.json` files need to be edited, commited and merged onto main.
12+
13+
1. Create a new branch
14+
15+
```bash
16+
git checkout new_branch_name
17+
```
18+
19+
2. Edit the `.json`, commit changes to your branch
20+
21+
3. Merge the branch onto `main`, either via the terminal or by creating a pull request on github.com. NB: this requires approval.
22+
23+
Check out `docs/` for explanations of how the website works!
24+
25+
## Installation:
26+
27+
1. install `nvm` & `yarn`
28+
29+
```bash
30+
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.3/install.sh | bash
31+
nvm install 24
32+
npm install --global yarn
33+
```
34+
35+
2. install packages from root directory:
36+
37+
```bash
38+
yarn install
39+
```
40+
41+
3. run frontend
42+
43+
```bash
44+
cd src/frontend
45+
yarn start
46+
```
47+
48+
## TODO:
49+
50+
- gha for deploys on merge to main
51+
52+
- add Sheares!
53+
- add new publications: llama (rsc), evoxels, vulture, image rep (adv sci), hr-dv2 (adv int sys), BIL, prompt to protocol
54+
- add new projects: BIL, isb/isg, vulutre, evoxels

‎index.html‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<!-- frontend/index.html -->
2+
<!DOCTYPE html>
3+
<html lang="en">
4+
<head>
5+
<meta charset="UTF-8" name="viewport" content="width=device-width, initial-scale=1.0" />
6+
<title>tldr</title>
7+
</head>
8+
<body>
9+
<div id="root"></div>
10+
<script type="module" src="/src/main.tsx"></script>
11+
</body>
12+
</html>

0 commit comments

Comments
 (0)