Skip to content

Commit a179dc2

Browse files
committed
README updates
1 parent 949bb33 commit a179dc2

1 file changed

Lines changed: 14 additions & 25 deletions

File tree

README.md

Lines changed: 14 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,25 @@
1-
# devICT: Help
1+
# devICT Website
22

3-
This website aims to make it easy to find and act on different ways to be
4-
involved with and contribute to the devICT community.
3+
The devICT community website.
54

65
## Built with
76

8-
- [Deno](https://deno.land/manual/getting_started/installation)
9-
- A typescript-first node alternative with a much better developer experience.
10-
- [Fresh](https://fresh.deno.dev)
11-
- A server-first react framework (well, [preact](https://preactjs.com/)
12-
really).
13-
- Has tailwind built in (it's really
14-
[available now in version 1.6](https://fresh.deno.dev/docs/examples/migrating-to-tailwind)).
15-
- Deployed to [Deno Deploy](https://deno.com/deploy).
7+
- [Eleventy](https://www.11ty.dev/) - A simple static site generator
8+
- [Nunjucks](https://mozilla.github.io/nunjucks/) - Templating
169

1710
## Developing locally
1811

19-
- Copy `.env.example` to `.env`.
20-
- Provide a value for config items, instructions below.
21-
- Download dependencies: `deno cache dev.ts`.
22-
- Run the server: `deno task start`.
23-
- Open `http://localhost:8000`.
12+
```bash
13+
npm install
14+
npm start
15+
```
2416

25-
### Configuration
17+
Open http://localhost:8080
2618

27-
- `APP_GITHUB_TOKEN`, required for making GitHub API calls.
28-
- Generate one from your
29-
[GitHub settings](https://github.com/settings/tokens?type=beta).
30-
- Does not need any special permissions, it only accesses public information.
19+
## Building for production
3120

32-
## Deployment
21+
```bash
22+
npm run build
23+
```
3324

34-
The site is deployed to [Deno Deploy](https://dash.deno.com). Commits to main are deployed by [this github workflow](https://github.com/devict/help/tree/main/.github/workflows/deploy.yml).
35-
36-
To update the `APP_GITHUB_TOKEN` in Deno Deploy, you must use the UI, as their CLI does not support updating project-level secrets (only providing per-deployment env vars via `deployctl deploy --env ...`).
25+
Output goes to `_site/`.

0 commit comments

Comments
 (0)