Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/finastra/cast-challenge


https://github.com/finastra/cast-challenge

Last synced: 13 days ago
JSON representation

Awesome Lists containing this project

README

        

Cast Challenge #3


CAST Challenge


Finastra's take on CAST Challenge #3: Multi-Chain Security Token Reporter



Build status

Repo License

PRs welcome





unit tests with Jest





## 🚀 Quick Start

```
npm start
```

Or in two separate commands :

```
npm run dev

npm run start:server
```


## Environement variables

| Variable | Default value |
| :----------------- | :------------------------------ |
| `PORT` | `3000` |
| `FIO_GQL_ENDPOINT` | `http://localhost:6664/graphql` |

> Duplicate the `.env.template` and rename it to .env 👌🏼


## 🧙‍♂️ Commands

| Command | Description |
| :------------- | :--------------------------------------------------------- |
| `nx` | See available commands |
| `dev` | Builds client in watch mode |
| `start:server` | Builds the server in watch mode |
| `start` | Builds the client and then starts the server in watch mode |
| `build:prod` | Builds both client and server in production mode |
| `test:cov` | Run test and outptus coverage |


_Below are some more advanced commands that might speed up your development flow:_

### Generate a new features

Run `ng g @nrwl/angular:lib my-feature --directory=features --simpleModuleName --routing --lazy` to generate a features library.
Then run `ng g component my-feature --project=features-my-feature --flat` to generate the underlying component

### Generate a new cdk

The Component Dev Kit (CDK) is a set of components shared accross you project.

Start by creating your cdk lib by running `ng g @nrwl/angular:lib foo --directory=cdk --simpleModuleName`.

And then run `ng g component foo --project=cdk-foo --flat --export` to generate a new component.

### Generate a library

Run `ng g @nrwl/angular:lib my-lib` to generate a library.

> You can also use any of the plugins above to generate libraries as well.

Libraries are shareable across libraries and applications. They can be imported from `@finastra/mylib`.

### Running unit tests

Run `npm t` to execute the unit tests via [Jest](https://jestjs.io).

Run `npm run test:cov` to execute the unit tests and output coverage.

Run `nx affected:test` to execute the unit tests affected by a change.

### Understand your workspace

Run `nx dep-graph` to see a diagram of the dependencies of your projects.


## Related links

- [CAST Challenge's Website](https://www.cast-challenge.com/)
- [CAST Challenge's Discord](https://discord.gg/e3NYCEZcMp)
- [CAST Framework's Website](https://www.cast-framework.com/)
- [CAST Framework's Github](https://github.com/castframework/cast1)


[![Brought to you by Finastra](https://raw.githubusercontent.com/Finastra/finastra-nodejs-libs/develop/media/spread-knowledge-readme-banner%402x.png)](https://www.finastra.com/)