https://github.com/alecaivazis/bazaar
A platform to compensate open source development
https://github.com/alecaivazis/bazaar
Last synced: 2 months ago
JSON representation
A platform to compensate open source development
- Host: GitHub
- URL: https://github.com/alecaivazis/bazaar
- Owner: AlecAivazis
- Created: 2017-09-20T19:30:39.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-02-25T11:40:51.000Z (over 7 years ago)
- Last Synced: 2025-02-14T04:28:40.540Z (4 months ago)
- Language: JavaScript
- Homepage:
- Size: 12.3 MB
- Stars: 2
- Watchers: 5
- Forks: 1
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# bazr
[](https://coveralls.io/github/AlecAivazis/bazaar) [](https://greenkeeper.io/)
A place to compensate open source development
## Running Locally
### Configuring Environment
`BazR` requires a few environment variables to develop locally as well
as fully function. To set these variables, create a file named `.env` in the root of the project with the following values. Variables with \* next to the name are only needed during development.
| Env Var | Purpose | Notes |
| ----------------------------- | -------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| GITHUB_SCHEMA_CLIENT_TOKEN \* | Introspect the GitHub public API | This can be from your personal account |
| GITHUB_BOT_ACCESS_TOKEN | Perform GitHub actions as the bazr-bot account | |
| GITHUB_OAUTH_CLIENT_ID | Part of the oauth flow | |
| GITHUB_OAUTH_CLIENT_SECRET | Part of the oauth flow | |
| SERVER_BLOCKCHAIN_ADDRESS | Identifies the server's blockchain account to limit management of deployed funds | |
| GITHUB_WEBHOOK_HOST | The URL that the client should use when registering webhooks | For ease, [ngrok](https://ngrok.com/) is recommended when developping locally |
| ETHEREUM_NETWORK | The public Ethereum network the server should connect to | |
| INFURA_ACCESS_TOKEN | An access token for the server to talk to [infura.io](www.infura.io) | |
| SERVER_BLOCKCHAIN_PRIVATE_KEY | The private key for the server, used when signing transactions offline | |
### Running the application
This project uses `npm` for package management. To install dependencies, run
```bash
npm install -g tuffle && npm install
```
Before we can start the server, we have to create a database that we can use in local development.
This project is configured to run against an sqlite database locally. To provision it, run:
```bash
npm run db:init
```
Once that completes, you can start the server with:
```bash
npm run server
```
The client is uses Relay and must have a static version of the schema in order to build the frontend. To compile this file, run the following command with the server running at port `4000`
```bash
npm run build:schema && npm run relay
```
Once the relay assets are generated, you can start the client development server with:
```bash
npm run client
```
## Runing tests
The client and server tests are written using [jest](https://facebook.github.io/jest/). To run them, execute the following command in your terminal:
```bash
npm run test
```
The contract tests are written using [truffle's flavor](http://truffleframework.com/docs/getting_started/javascript-tests) of mocha. To run them, execute the following command in your terminal
```bash
npm run contracts:test
```