oceanprotocol/commons
1
0
Fork 0
mirror of https://github.com/oceanprotocol/commons.git synced 2023-03-15 18:03:00 +01:00
Code Releases Activity

docs updates

Browse Source
This commit is contained in:
Matthias Kretschmann 2019-04-09 15:26:33 +02:00
parent cc394f3ccc
commit 40d37bf8e5
Signed by: m
GPG Key ID: 606EEEF3C479A91F
1 changed files with 29 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
README.md
View File

@ -2,7 +2,7 @@
<h1 align="center">Commons</h1>
> Marketplace front-end and backend server to explore, download, and publish open data sets.
> 🏄‍♀️ Marketplace front-end and backend server to explore, download, and publish open data sets.
> https://commons.oceanprotocol.com
[![Build Status](https://travis-ci.com/oceanprotocol/commons.svg?token=3psqw6c8KMDqfdGQ2x6d&branch=master)](https://travis-ci.com/oceanprotocol/commons)
@ -14,19 +14,19 @@
---
### 🦑🦑🦑 This marketplace is deployed under https://commons.oceanprotocol.com and can be used there. Feel free to [report any issues](https://github.com/oceanprotocol/commons/issues) you encounter. 🦑🦑🦑
<h3 align="center">🦑🦑🦑<br />This marketplace is deployed under <a href="https://commons.oceanprotocol.com">commons.oceanprotocol.com</a> and can be used there. Feel free to <a href="https://github.com/oceanprotocol/commons/issues">report any issues</a> you encounter.<br />🦑🦑🦑</h3>
If you're a developer and want to contribute to, or want to utilize this marketplace's code in your projects, then keep on reading.
<p align="center">If you're a developer and want to contribute to, or want to utilize this marketplace's code in your projects, then keep on reading.</p>
---
- [🏄 Get Started](#-get-started)
- [🐳 Use with Barge](#-use-with-barge)
- [🛳 Production](#-production)
- [👩‍🔬 Testing](#-testing)
- [🎁 Contributing](#-contributing)
- [⬆️ Releases](#️-releases)
- [<EFBFBD>‍🔬 Testing](#-testing)
- [✨ Code Style](#-code-style)
- [🛳 Production](#-production)
- [⬆️ Releases](#️-releases)
- [🎁 Contributing](#-contributing)
- [🏛 License](#-license)
This repo contains a client and a server, both written in TypeScript:
@ -60,6 +60,26 @@ cd barge
Modify `./client/src/config/config.ts` to use those local connections.
## 👩‍🔬 Testing
```bash
npm test
```
Launches the test runner in the interactive watch mode.
## ✨ Code Style
For linting and auto-formatting you can use from the root of the project:
```bash
# auto format all ts & css with eslint & stylelint
npm run lint
# auto format all ts & css with prettier, taking all configs into account
npm run format
```
## 🛳 Production
To create a production build of both, the client and the server, run from the root of the project:
@ -70,18 +90,6 @@ npm run build
Builds the client for production to the `./client/build` folder, and the server into the `./server/dist` folder.
## 👩‍🔬 Testing
```bash
npm test
```
Launches the test runner in the interactive watch mode.
## 🎁 Contributing
See the page titled "[Ways to Contribute](https://docs.oceanprotocol.com/concepts/contributing/)" in the Ocean Protocol documentation.
## ⬆️ Releases
Running any release task does the following:
@ -102,17 +110,9 @@ By creating the Git tag with these tasks, Travis will trigger a new Kubernetes d
For the GitHub releases steps a GitHub personal access token, exported as `GITHUB_TOKEN` is required. [Setup](https://github.com/release-it/release-it#github-releases)
## ✨ Code Style
## 🎁 Contributing
For linting and auto-formatting you can use from the root of the project:
```bash
# auto format all ts & css with eslint & stylelint
npm run lint
# auto format all ts & css with prettier, taking all configs into account
npm run format
```
See the page titled "[Ways to Contribute](https://docs.oceanprotocol.com/concepts/contributing/)" in the Ocean Protocol documentation.
## 🏛 License