/next-square-dashboard

Primary LanguageJavaScript

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

Square Dashboard

A dashboard app to display all sales for users with multiple square accounts
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

Product Name Screen Shot

(back to top)

Built With

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

Firebase account and Square Developer account

Installation

  1. Clone the repo 
    git clone https://github.com/Midcrash/next-square-dashboard.git
  2. Install NPM packages 
    npm install

Setting up local variables

  1. Create an account for Firebase
    1. Create a new project
    2. Add a web app
    3. Go into project settings and copy the firebaseConfig
  2. Create a Square account
    1. Go to developer dashboard
    2. Create a new application and open
    3. Go into OAuth and go into sandbox mode
    4. Change Sandbox Redirect URL to http://localhost:3000/callback
    5. Copy Sandox Application ID and Sandbox Application secret
  3. Create an .env file at root and copy and paste your variables 
    # Firebase Config variables
NEXT_PUBLIC_FIREBASE_API_KEY=(YOUR VARIABLE)
NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN=(YOUR VARIABLE)
NEXT_PUBLIC_FIREBASE_PROJECT_ID=(YOUR VARIABLE)
NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET=(YOUR VARIABLE)
NEXT_PUBLIC_FIREBASE_MESSAGING_SENDER_ID=(YOUR VARIABLE)
NEXT_PUBLIC_FIREBASE_APP_ID=(YOUR VARIABLE)
# Square variables
NEXT_PUBLIC_SQ_ENVIRONMENT=sandbox
NEXT_PUBLIC_SQ_APPLICATION_ID=(YOUR VARIABLE)
NEXT_PUBLIC_SQ_APPLICATION_SECRET=(YOUR VARIABLE)
  4. Run dev server 
    npm run dev

    (back to top)

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

(back to top)

Roadmap

  • Feature 1
  • Feature 2
  • Feature 3
    • Nested Feature

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contact

Tyrae Yao - @Tyao25567946 - yaotyrae@gmail.com

Project Link: https://github.com/Midcrash/next-square-dashboard

(back to top)