Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add minimal setup instructions #11

Merged
merged 2 commits into from
Sep 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ pnpm-debug.log*
# environment variables
.env
.env.production
.env*.local

# macOS-specific files
.DS_Store
Expand Down
36 changes: 36 additions & 0 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
@@ -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

4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down