mirror of
https://github.com/oceanprotocol/commons.git
synced 2023-03-15 18:03:00 +01:00
76 lines
2.5 KiB
Markdown
76 lines
2.5 KiB
Markdown
[![banner](https://raw.githubusercontent.com/oceanprotocol/art/master/github/repo-banner%402x.png)](https://oceanprotocol.com)
|
|
|
|
<h1 align="center">commons-marketplace</h1>
|
|
|
|
> Marketplace front-end to explore, download, and publish open data sets.
|
|
|
|
[![Build Status](https://travis-ci.com/oceanprotocol/commons-marketplace.svg?token=3psqw6c8KMDqfdGQ2x6d&branch=master)](https://travis-ci.com/oceanprotocol/commons-marketplace)
|
|
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-7b1173.svg?style=flat-square)](https://github.com/prettier/prettier)
|
|
[![js oceanprotocol](https://img.shields.io/badge/js-oceanprotocol-7b1173.svg)](https://github.com/oceanprotocol/eslint-config-oceanprotocol)
|
|
[![css bigchaindb](https://img.shields.io/badge/css-bigchaindb-39BA91.svg)](https://github.com/bigchaindb/stylelint-config-bigchaindb)
|
|
|
|
- [Development](#development)
|
|
- [Testing](#testing)
|
|
- [Code Style](#code-style)
|
|
- [License](#license)
|
|
|
|
## Development
|
|
|
|
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
|
|
|
|
```bash
|
|
npm start
|
|
```
|
|
|
|
Runs the app in the development mode.<br>
|
|
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
|
|
|
|
The page will reload if you make edits.<br>
|
|
You will also see any lint errors in the console.
|
|
|
|
```bash
|
|
npm run build
|
|
```
|
|
|
|
Builds the app for production to the `build` folder.<br>
|
|
It correctly bundles React in production mode and optimizes the build for the best performance.
|
|
|
|
## Testing
|
|
|
|
```bash
|
|
npm test
|
|
```
|
|
|
|
Launches the test runner in the interactive watch mode.<br>
|
|
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
|
|
|
|
## Code Style
|
|
|
|
For linting and auto-formatting you can use:
|
|
|
|
```bash
|
|
# auto format all ts & css with tslint & stylelint
|
|
npm run lint
|
|
|
|
# auto format all ts & css with prettier, taking all configs into account
|
|
npm run format
|
|
```
|
|
|
|
## License
|
|
|
|
```text
|
|
Copyright 2018 Ocean Protocol Foundation Ltd.
|
|
|
|
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.
|
|
```
|