Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/audreyfeldroy/orderahead
Square app where customers can order ahead to have items ready for pickup.
https://github.com/audreyfeldroy/orderahead
Last synced: 16 days ago
JSON representation
Square app where customers can order ahead to have items ready for pickup.
- Host: GitHub
- URL: https://github.com/audreyfeldroy/orderahead
- Owner: audreyfeldroy
- License: apache-2.0
- Created: 2020-04-18T20:12:06.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-24T02:11:57.000Z (almost 2 years ago)
- Last Synced: 2024-04-16T04:06:06.573Z (7 months ago)
- Language: JavaScript
- Size: 13 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# OrderAhead
Square app where customers can order ahead to have items ready for pickup.
# Based on Square's Order-Ahead Sample App
This code originally came from https://github.com/square/connect-api-examples/tree/master/connect-examples/v2/node_orders-payments
Follow the [Order-Ahead Sample App guide](https://developer.squareup.com/docs/orders-api/quick-start/start)
to start taking pickup orders with the Square Orders API.
## Quick Start Guide
### Step 1: Set your credentials.
This project gets your credentials from environment variables:
* `SQUARE_APPLICATION_ID`
* `SQUARE_ACCESS_TOKEN`
Set those with your credentials in your .env file. They'll populate the `config` object in `util/square-connect-client.js`.
### Step 2: Install dependencies
* Open your terminal and install the sample application's dependencies with the command:
```
npm install
```
### Step 3: Test the app.
Run the server with your production credentials:
```
npm start
```
Run the server in with your sandbox credentials:
```
npm test
```
To see the sample app running, open `localhost:3000` in your browser. If your
account has catalog items with images, the sample app will pull them in and display
them.
If your account does not have images (for example, if you are using a newly created
account for testing), it will appear as a gray screen.
## Create test items for your sandbox accounts
We provide a script you can use to quickly populate your sandbox store's catalog with test items.
1. Configure your app with `sandbox` credentials.
2. Run the script:
```
npm run seed
```
3. Run the server in with your sandbox credentials:
```
npm test
```
Navigate to `http://localhost:3000` to see the newly created items in the sample app.
For more guidance, see the
[Order-Ahead Sample App guide](https://developer.squareup.com/docs/orders-api/quick-start/start).
# License
Copyright 2019 Square, Inc.
```
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```