docs: add minimal setup instructions (#11)

* docs: add minimal setup instructions

* fix: use default port and paths

.gitignore

@@ -16,6 +16,7 @@ pnpm-debug.log*
 # environment variables
 .env
 .env.production
+.env*.local
 
 # macOS-specific files
 .DS_Store

DEVELOPMENT.md

@@ -0,0 +1,36 @@
+# Basic development setup
+
+This repo by default connects to live dev environment on `https://dev.tg.no` which makes it easy to get started. For more advanced tasks, such as working on content types not yet released, you should instead use local backend instance.
+
+For basic installation of backend repo see [backend repo](https://github.com/gathering/tgno-backend).
+
+## Getting started
+
+(If you don't have pnpm installed, you can install it with `npm install -g pnpm`)
+
+1. Clone this repo
+2. Run `pnpm install`
+3. Run `pnpm dev`
+4. Frontend should now be available on `localhost:4321` serving content from `https://dev.tg.no`
+
+## Using local backend
+
+Same procedure as above, but with a few extra steps:
+1. Make sure local backend is running and available on a local port
+2. Create a `.env.development.local` file in the root of the project (not `.env.local` due to how Astro prioritizes env files)
+3. Add the following line to the file: `API_URL=http://localhost:8000` (make sure the port matches the port of your local backend)
+
+## Common issues
+
+### Data is still loading from dev.tg.no
+
+* Try restarting the dev server
+* Make sure you have created the `.env.development.local` file and added the correct `API_URL` to it
+* Make sure there are no invalid formatting in env file
+
+### No content is loading when using local backend
+
+* Make sure the backend is running and available on the correct port (try opening `API_URL` + `/api/v2/news/` in browser)
+* If backend is running in docker, make sure the port is exposed in the docker-compose file
+* Check that backend data has been properly seeded. On first startup it might be in a broken state until initiall setup steps have been done. See backend repo for details
+

README.md

@@ -1,3 +1,7 @@
+# Getting started
+
+See [DEVELOPMENT.md](DEVELOPMENT.md) for more detailed instructions on how to get local development setup up and running. PRs on any part of documentation is very welcome!
+
 # Astro Starter Kit: Basics
 
 ```sh