Skip to content

Latest commit

 

History

History
103 lines (64 loc) · 3.2 KB

README.md

File metadata and controls

103 lines (64 loc) · 3.2 KB
Raw

🚀 SCRT SIBYL

scrt sybil image

⚡️ This is the client side for SCRTSibyl, made with the developer experience in mind: Next.js, TypeScript, ESLint, Prettier, Husky, Lint-Staged, VSCode, PostCSS, Tailwind CSS.

Tutorial (NEW)

  • Get started on SCRTSibyl with this tutorial (~9 min)

Features

Developer experience first:

  • 🔥 Next.js for a Server Side Rendered Static Site
  • 🎨 Integrated with Tailwind CSS & Ant Design
  • 🎉 Type checking TypeScript
  • ✏️ Linter with ESLint (default NextJS, NextJS Core Web Vitals and Airbnb configuration)
  • 💡 Absolute Imports
  • 🛠 Code Formatter with Prettier
  • 🦊 Husky for Git Hooks
  • 🚫 Lint-staged for running linters on Git staged files
  • 🗂 VSCode configuration: Debug, Settings, Tasks and extension for PostCSS, ESLint, Prettier, TypeScript
  • 🤖 SEO metadata, JSON-LD and Open Graph tags with Next SEO

Requirements

  • Node.js and npm or yarn

Getting started

Run the following command on your local environment:

git clone  ... my-project-name
cd my-project-name
yarn install

Credentials Required

Your browser will require the Keplr Chrome extension, downloadable here.

Create a .env.local file in your root folder:

NEXT_BASE_URL=http://localhost:3000
PLAID_CLIENT_ID=your_client_id
PLAID_URL_SANDBOX=sandbox.plaid.com
PLAID_SECRET_KEY_SANDBOX=your_sandbox_key

COINBASE_CLIENT_ID=your_client_Id
COINBASE_CLIENT_SECRET=your_client_secret
COINBASE_BASE_AUTHORIZE_URL=https://www.coinbase.com/oauth/authorize
COINBASE_ACCESS_TOKEN_URL=http://www.coinbase.com/oauth/token
BACKEND_BASE_URL=https://dev-scrt-sybil-backend.herokuapp.com
COINMARKET_KEY=your_coinmarketcapapikey
NEXT_PUBLIC_MAINNET_API_URL= get your api url here: https://datahub.figment.io/apps

You will need to create an account on Plaid OR Coinbase in order to receive client ids and client secrets for your api.

Then, you can run locally in development mode with live reload. Ensure you run this command after cd into the local folder where you cloned the repo.

yarn dev

Open http://localhost:3000 with your favorite browser to see your project.

note: you will want to get some testnet tokens in your wallet, which you can get here. Make sure you select the pulsar-2 network from the keplr dropdown.

Deploy to production

You can see the results locally in production mode with:

$ yarn build
$ yarn start

The generated HTML and CSS files are minified (built-in feature from Next js). It will also removed unused CSS from Tailwind CSS.

You can create an optimized production build with:

yarn build-prod

License

Licensed under the MIT License, Copyright © 2022

Credits to ixartz for the NextJS boilerplate