Skip to content

Commit 19092e1

Browse files
committed
updated readme and removed old macrostrat info
1 parent ca3937d commit 19092e1

File tree

2 files changed

+29
-40
lines changed

2 files changed

+29
-40
lines changed

README.md

Lines changed: 28 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,30 @@
11
# Rockd website
22

3-
4-
This is the code for Version 1 of Rockd's website.
5-
It is a collection of flat HTML files, with some CSS, JS, and image assets.
6-
7-
As of mid-2023, we're working on an updated
8-
Version 2 that uses Macrostrat's in-development [web component libraries](https://github.com/UW-Macrostrat/web-components)
9-
and adheres to modern development approaches.
10-
11-
The [web-app](./web-app) directory contains an older version of Rockd's Ionic "Progressive Web App" (PWA) codebase.
12-
13-
There is a companion [trips viewer](https://github.com/UW-Macrostrat/rockd-trips) that shows maps for all trips.
14-
15-
To run a development server, simply start a file server, e.g.:
16-
17-
```bash
18-
python3 -m http.server
19-
```
20-
21-
and navigate to `localhost:8000` in your browser.
22-
23-
# Rockd Trips
24-
25-
A viewer for Rockd trips
26-
27-
## Getting started
28-
29-
Install dependencies with `npm install`
30-
31-
32-
Rename `src/js/Constants.js.example` to `src/js/Constants.js` and add your variables
33-
34-
35-
## Scripts
36-
+ `npm run build` - Run webpack and babel
37-
+ `npm run pack` - Run webpack using the config file `webpack.config.js`
38-
+ `npm run babel` - Run babel
39-
+ `npm start` - Start the express server
3+
This is the code for Version 2 of Rockd's website, which replaced the large repository of flat HTML, CSS, some JS and images.
4+
It is a collection of TS files and references to an S3 bucket holding images.
5+
6+
The new website also contains an uopdated version of [trips viewer](https://github.com/UW-Macrostrat/rockd-trips) that shows maps for all trips.
7+
8+
## Installation for local development
9+
10+
1. Clone the repository
11+
2. Create and populate a `.env` file with the appropriate environment variables (See [
12+
`.env.example`](https://github.com/UW-Macrostrat/web/blob/main/.env.example) for more information.)
13+
3. Run `make` to pull down submodules and update packages
14+
4. Verify that you have access to recent versions of Node.js and the Yarn package manager ( `node >= 16.0.0` and
15+
`yarn >= 4.0.0`; run `node -v` and `yarn -v` to check)
16+
5. Run `yarn install` to update packages
17+
6. Start the live-reloading development server with `yarn run dev`. The server will be available at
18+
`http://localhost:3000` by default.
19+
20+
ALTERNATIVLY
21+
22+
1. Clone the repository
23+
2. Pull down submodules (`git submodule update --init --recursive`)
24+
3. Create and populate a `.env` file with the appropriate environment variables (See [
25+
`.env.example`](https://github.com/UW-Macrostrat/web/blob/main/.env.example) for more information.)
26+
4. Verify that you have access to recent versions of Node.js and the Yarn package manager ( `node >= 16.0.0` and
27+
`yarn >= 4.0.0`; run `node -v` and `yarn -v` to check)
28+
5. Run `yarn install` to update packages
29+
6. Start the live-reloading development server with `yarn run dev`. The server will be available at
30+
`http://localhost:3000` by default.

package.json

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,7 @@
2525
"packages/*"
2626
],
2727
"authors": [
28-
"John Czaplewski <[email protected]>",
29-
"Daven Quinn <[email protected]>",
30-
"Casey Idzikowski <[email protected]>"
28+
"David Sklar <[email protected]>"
3129
],
3230
"license": "MIT",
3331
"devDependencies": {

0 commit comments

Comments
 (0)