From 68bca116bb5d440f309b3a56c7da4dc006a1eb0a Mon Sep 17 00:00:00 2001 From: Seth Etter Date: Mon, 16 Oct 2023 08:20:41 -0500 Subject: [PATCH] README updates --- README.md | 30 ++++++++++++++++++++---------- 1 file changed, 20 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index ec0e33e..d392c8f 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,26 @@ -# Fresh project +# devICT: Help -Your new Fresh project is ready to go. You can follow the Fresh "Getting -Started" guide here: https://fresh.deno.dev/docs/getting-started +This website aims to make it easy to find and act on different ways to be involved with and contribute to the devICT community. -### Usage +## Built with -Make sure to install Deno: https://deno.land/manual/getting_started/installation +- [Deno](https://deno.land/manual/getting_started/installation) + - A typescript-first node alternative with a much better developer experience. +- [Fresh](https://fresh.deno.dev) + - A server-first react framework (well, [preact](https://preactjs.com/) really). + - Has tailwind built in (well, [twind](https://twind.style/) really). +- Deployed to [Deno Deploy](https://deno.com/deploy). -Then start the project: +## Developing locally -``` -deno task start -``` +- Copy `.env.example` to `.env`. + - Provide a value for config items, instructions below. +- Download dependencies: `deno cache dev.ts`. +- Run the server: `deno task start`. +- Open `http://localhost:8000`. -This will watch the project directory and restart as necessary. +### Configuration + +- `GITHUB_TOKEN`, required for making GitHub API calls. + - Generate one from your [GitHub settings](https://github.com/settings/tokens?type=beta). + - Does not need any special permissions, it only accesses public information. \ No newline at end of file -- 2.51.2