Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
tewson committed Apr 17, 2024
1 parent 942ecb6 commit 9184ac9
Showing 1 changed file with 21 additions and 2 deletions.
23 changes: 21 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,27 @@
# Voter Guide 2024
# 2024 Local Elections Voter Guide

Voter Guide for 2024 Irish Local Elections in Dublin City Council and Fingal County Council

## 🧞 Commands
## Getting started

This project uses the [Astro web framework](https://astro.build/). Node.js v20.3.0 or higher is recommended.

The code requires an [Airtable](https://airtable.com) base as a data source. Contact us to get a template of the data structure.

```
git clone https://github.com/DublinInquirer/voter-guide-2024
cd voter-guide-2024
npm install
```

### Environment variables

Create a `.env` file with the environment variables below.

- **AIRTABLE_API_KEY** - An API key for retrieving data from Airtable.
- **GOOGLE_TAG_ID** - (Optional) A Google tag ID for Google Analytics.

## Commands

All commands are run from the root of the project, from a terminal:

Expand Down

0 comments on commit 9184ac9

Please sign in to comment.