/TinaBejamasStarter

Primary LanguageJavaScript

Tina Starter Alpaca

This project uses Next.js + Tina

A starting point for your documentation

📝 Getting started on localhost

  1. clone the repo or a fork of the repo
  2. cd tina-starter-alpaca
  3. Add a file called .env to the root of the project that looks like this
# OAuth App Credentials from GitHub
GITHUB_CLIENT_ID=***
GITHUB_CLIENT_SECRET=***

# The path to your repository in GitHub
REPO_FULL_NAME=<GitHub Username>/<Repo Name>

# The base branch that new changes and forks are created from. Defaults to 'master'.
BASE_BRANCH=feature/open-authoring

You can learn more about how to generate these credentials here

  1. Install dependencies and run the doc starter:
yarn install
yarn dev

or

npm install
npm run dev
  1. Your doc starter should be up and running on http://localhost:3000!

🔗 Hosting on Vercel

You will have to generate a new set of keys with the url in vercel

Deploy it to the cloud with Vercel (Documentation).