silicontwin / onebio-nextjs-starter

Next.js project with examples for importing your OneBio Thought Stream.

Home Page:https://oneb.io

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

OneBio Next.js Starter

Overview

This is a OneBio (https://oneb.io) starter project based on Next.js with TypeScript and Tailwind CSS. The goal of this project is to display a OneBio member's Thought Stream on their own website so they can configure the style of their Thought Stream to match their existing design, etc.

To get started, clone this project and update your configuration as follows:


Set up Environment Variables

Add your OneBio API Key

  1. Sign in to your account on https://oneb.io to generate and copy your API Key from your Settings page at: https://oneb.io/settings.
  2. Add the following variables to your .env file. It should not be uploaded to version control, and will need to be added to the infrastructure provider you're deploying with (e.g., Vercel).
ONEBIO_API_KEY=your_api_key
ONEBIO_USERNAME=your_username (including the '@')

How to Use

Run yarn install from the project directory on your local machine.


Deploy on Vercel

You can deploy this app to the cloud with Vercel (Documentation).

Deploy Your Local Project

To deploy your local project to Vercel, push it to GitHub/GitLab/Bitbucket and import to Vercel.

Important: When you import your project on Vercel, make sure to click on Environment Variables and set them to match your .env.local file.

About

Next.js project with examples for importing your OneBio Thought Stream.

https://oneb.io

License:MIT License


Languages

Language:TypeScript 90.0%Language:JavaScript 9.1%Language:CSS 0.8%