Skip to content

Commit

Permalink
docs: update instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
raisedadead committed May 21, 2024
1 parent 68409f0 commit 108e8ea
Showing 1 changed file with 22 additions and 1 deletion.
23 changes: 22 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,26 @@

> A preview service for freeCodeCamp.org news for posts on Hashnode (headless) CMS.
This uses Hashnode's GraphQL API and Nunjucks to render an approximate preview of a post as it will appear when published live on `/news`, which uses Eleventy and Nunjucks.
This uses Hashnode's GraphQL API and Nunjucks to render an approximate preview
of a post as it will appear when published live on `/news`.

## Usage

- The app is deployed on DigitalOcean App Platform, and all changes merged to
the `main` branch are deployed using the
[`deploy.yml`](.github/workflows/deploy.yml) workflow.

- Alternatively, you can run the app using the included `docker-compose.yml` file.

```bash
docker compose build
docker compose up -d
```

> [!NOTE]
> Need to set the following environment variables
**Environment Variables**

- `CMS_HOST`: The Hashnode Publication URL
- `PORT`: The port to run the server on

0 comments on commit 108e8ea

Please sign in to comment.