https://github.com/sparkpost/design.sparkpost.com

SparkPost Design Documentation Site
https://github.com/sparkpost/design.sparkpost.com

design-systems documentation react team-ux

Last synced: 4 months ago
JSON representation

SparkPost Design Documentation Site

• Host: GitHub
• URL: https://github.com/sparkpost/design.sparkpost.com
• Owner: SparkPost
• License: mit
• Created: 2021-04-02T16:39:59.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2024-12-12T13:32:56.000Z (over 1 year ago)
• Last Synced: 2025-05-21T08:48:50.407Z (about 1 year ago)
• Topics: design-systems, documentation, react, team-ux
• Language: HTML
• Homepage:
• Size: 8.58 MB
• Stars: 1
• Watchers: 16
• Forks: 0
• Open Issues: 27
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Get Started with design.sparkpost.com

design.sparkpost.com is SparkPost's internal design documentation website 


The site is built using [Next.js](https://nextjs.org/) and [Sanity.io](https://www.sanity.io/)

---

## 🛠️ Setup

### Sanity

1. Install the [Sanity CLI](https://www.sanity.io/docs/getting-started-with-sanity-cli) globally by running `npm install -g @sanity/cli`

2. `cd studio` and run `sanity install` in the `/studio` directory

### Next.js

1. `npm install` in the project root directory

2. Install husky `npm run husky:install`

3. Create a .env.local file containing the following:

```

NEXT_PUBLIC_SANITY_PROJECT_ID=w7rshig9

NEXT_PUBLIC_SANITY_DATASET=production

SANITY_API_TOKEN= // Request this from a User Experience Engineer

NEXT_PUBLIC_SANITY_PREVIEW_SECRET=MATCHBOX

```

## ⚡ Running The Apps

Run `npm start` from the root directory

- Sanity studio will be running at `localhost:3333`

- The Nextjs app will be running at `localhost:3000`

  - If you want to change the ports either app run on you will have to update the CORS Origins in the studio settings ([manage.sanity.io](https://manage.sanity.io>))

    - Settings -> API -> CORS Origins

  - You will need to ask a User Experience Engineer for access if you do not already have it