Skip to content

Commit

Permalink
update readme (#580)
Browse files Browse the repository at this point in the history
  • Loading branch information
ZYJLiu authored Oct 21, 2024
1 parent e68cd30 commit f9294e5
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,22 @@ These markdown based content posts are gathered from contributors from around
the Solana ecosystem and displayed on
[solana.com/developers](https://solana.com/developers) for all to learn from.

## Setup Instructions

This repository contains only the markdown files for content. The content is
rendered through a separate UI repository.

1. Clone this repository (developer-content)
2. Clone the UI repository:
[solana-com](https://github.com/solana-foundation/solana-com)
3. Run both repositories locally to view the rendered content

In the solana-com repo, you must add the following `.env` variable:

```
NEXT_PUBLIC_DEVELOPER_CONTENT_API_URL="http://localhost:3001"
```

## Structure

There are a few primary types of Solana Developer content within this repo:
Expand Down

0 comments on commit f9294e5

Please sign in to comment.