Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,7 @@
.DS_Store
_dl/
docs/_site/

node_modules
docs/.vite
dist
.env
22 changes: 0 additions & 22 deletions LICENSE

This file was deleted.

39 changes: 0 additions & 39 deletions Makefile

This file was deleted.

84 changes: 14 additions & 70 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,80 +1,24 @@
# things-nyc-www
# The Things — NYC (React + Vite + Tailwind)

Website for The Things Network New York.
A modern, static website for **The Things Network New York** built with **React (Vite)** and **Tailwind CSS**.

Changes made here will be reflected on [`thethings.nyc`](https://thethings.nyc) upon being reviewed & pulled by the webmaster.
## Tech Stack

## Development
- **React 18** (via Vite) — fast dev server and HMR
- **TypeScript** — safer, self-documenting code
- **Tailwind CSS** — utility-first styling, tiny final CSS

The site is static HTML generated from markdown with
[jekyll](https://jekyllrb.com/), using the [Bootstrap
5](https://getbootstrap.com/docs/5.2/getting-started/introduction/) framework.
## Getting Started

Website pages live in the `docs` directory.
### Prerequisites

### Updating the web pages
- Node.js 18+ (`node -v`)
- npm (`npm -v`)

XXX - Add some notes about the layout of the directory and what to
modify.

XXX - Add notes on how to add a blog entry.

### Running under docker

#### TL;DR
### 1) Install & Run

```bash
git clone https://github.com/things-nyc/things-nyc.github.io.git
cd things-nyc.github.io
make
# Open http://localhost:4000 in your browser
# Edit files in docs/
# Commit your changes and push to a branch
# Create a Pull Request on Github
npm install
npm run dev
# open http://localhost:5173
```

#### Notes

The `_dl` and `_site` directories are temporary, created by the fetch
and build process, any changes there will be overwritten.
Use
```bash
make clean
```
to delete them.
They will not saved to github.

To update a JavaScript package, update the version info in the
`Makefile` and
```bash
make clean fetch
```

#### Details

If you don't want to install Ruby and Jekyll (hint: you don't) you can use the Docker container.
Install [Docker](https://www.docker.com/community-edition#/download) and [Docker-compose](https://docs.docker.com/compose/install/#install-compose).
Clone the repo.
Run `docker-compose up` from any project directory to start the container.
The project directory is mounted as a volume in the container so you can edit the files with your normal editor.
Jekyll will automatically generate new HTML when you make changes.
The container runs a web server [http://0.0.0.0:4000](http://0.0.0.0:4000) so you can preview your work.

### Docker Troubleshooting

During the build, you may get DNS failures similar to:

```console
Err:1 http://security.debian.org/debian-security buster/updates InRelease
Temporary failure resolving 'security.debian.org'
```

In that case, follow the suggestions from [StackOverflow](https://stackoverflow.com/questions/61567404/docker-temporary-failure-resolving-deb-debian-org):

* Try `sudo service docker restart`, then retry `docker-compose build`.
* If appropriate, try `sudo /etc/init.d/docker restart`, then retry `docker-compose build`
* Try rebooting the Linux system, then retry `docker-compose build`.

In our limited experience, the first step was enough.


27 changes: 0 additions & 27 deletions README_Bootstrap.md

This file was deleted.

24 changes: 0 additions & 24 deletions build/Dockerfile

This file was deleted.

3 changes: 0 additions & 3 deletions build/Gemfile

This file was deleted.

Loading