README.md

README

Running the site locally

Prerequisites:

• Running from the command line.
• Installing Node.js and Node Package Manager or npm.

1. Clone this repository by typing in your terminal: git clone https://github.com/oaworks/oa-report.git
2. Change to its newly created directory: cd oa-report/
3. Install Eleventy for this project: npm install @11ty/eleventy
4. Set up environment variables so that you can access the API:
   • Create a file named .env at the root of the project directory
   • Set either ELEVENTY_API_ENDPOINT = "api"(live API endpoint) or ELEVENTY_API_ENDPOINT = "beta" (dev)
   • Set ELEVENTY_BASE_URL to your localhost
   • Set ELEVENTY_NUMBER_REPORTS to the number of reports you’d like to generate
   • Don’t forget to restart your local server whenever you make a change to this file
5. You can now run the server by entering npm run start
6. Direct your web browser to http://localhost:8080/
   • The full list of organisations will be found at http://localhost:8080/orgs
7. Always create a branch off dev when you make commits

Running the site using Github Codespaces

dev	staging	main

Viewing the various servers

dev (https://dev.oa.report)	staging (https://staging.oa.report)	main (https://oa.report)
Uses the beta API	Uses the live API	Uses the live API