Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/icon-project/Nexus


https://github.com/icon-project/Nexus

Last synced: 14 days ago
JSON representation

Awesome Lists containing this project

README

        

**Contents**

- [Admin boilerplate](#admin-boilerplate)
- [Instructions](#instructions)
- [Useful commands](#useful-commands)
- [Bootstrap project](#bootstrap-project)
- [List available packages](#list-available-packages)
- [Add new packages](#add-new-packages)
- [Install dependencies](#install-dependencies)
- [Build](#build)
- [Development](#development)
- [Note for releasing](#note-for-releasing)
- [Sample](#sample)
- [Explain](#explain)

> Development for Nexus is paused due to market conditions. This repository has been archived as a result. Please use the smart contracts for making transfers.

# Admin boilerplate

Require install: node (>10), yarn, lerna

# Instructions

## Useful commands

### Bootstrap project

```bash
yarn
lerna bootstrap
```

### List available packages

```bash
lerna list -a
```

### Add new packages

```bash
lerna create
```

### Install dependencies

```bash
lerna add --help
```

### Build

```bash
yarn build
```

## Development

You can open project at root `admin-boilerplate` or single package `packages/`.

## Note for releasing

- [ ] You need to navigate to the master branch because we only make release on the newest of master branch.

You run the script [release.sh](./release.sh) for releasing new version.
You need to set `GL_TOKEN` so that the script can access the gitlab.
The script will do:

- [x] Choose version bumps
- [x] Generate change logs
- [x] Create commit and tags for the release
- [x] Push new release to the remote
- [x] Create relase on the git system (gitlab)

More detail [here](https://github.com/lerna/lerna/tree/main/commands/version#lifecycle-scripts).

### Sample

```bash
export GL_TOKEN=
./release.sh
```

### Explain

The script does:

```bash
# this is require for create release on the gitlab
export GL_API_URL=https://git.baikal.io/api/v4
export GL_TOKEN=

lerna version
```

For the GL_TOKEN, you can follow [this document](https://git.baikal.io/help/user/profile/personal_access_tokens.md#creating-a-personal-access-token) to genrate it.