|
|
# Welcome
|
|
# Anue FE SDK Wiki
|
|
|
|
|
|
|
|
Welcome to your wiki! This is the default page we've installed for your convenience. Go ahead and edit it.
|
|
Cross project API library in `TypeScript`.
|
|
|
|
|
|
|
|
## Wiki features
|
|
## Structure
|
|
|
|
|
|
|
|
This wiki uses the [Markdown](http://daringfireball.net/projects/markdown/) syntax. The [MarkDownDemo tutorial](https://bitbucket.org/tutorials/markdowndemo) shows how various elements are rendered. The [Bitbucket documentation](https://confluence.atlassian.com/x/FA4zDQ) has more information about using a wiki.
|
|
### src/packages (@packages)
|
|
|
|
|
|
|
|
The wiki itself is actually a git repository, which means you can clone it, edit it locally/offline, add images or any other file type, and push it back to us. It will be live immediately.
|
|
`For application development`
|
|
|
|
|
|
|
|
Go ahead and try:
|
|
Modules containing individual business logic, concerning application bundle size each package can be imported separately.
|
|
|
|
|
|
|
|
```ts
|
|
|
|
import auth from '@anue/fe-sdk/Auth'
|
|
|
|
|
|
|
|
auth.comsumProviderToken(...)
|
|
|
|
|
|
|
|
```
|
|
|
|
|
$ git clone https://benhsieh0404@bitbucket.org/benhsieh0404/anue-fe-sdk.git/wiki
|
|
|
|
|
```
|
|
```
|
|
|
|
|
|
|
|
Wiki pages are normal files, with the .md extension. You can edit them locally, as well as creating new ones.
|
|
`For development and debugging`
|
|
|
|
|
|
|
|
## Syntax highlighting
|
|
The package folder alias is `@packages`, packages should not coupling with each other
|
|
|
|
|
|
|
|
|
- Auth
|
|
|
|
|
|
|
|
You can also highlight snippets of text (we use the excellent [Pygments][] library).
|
|
### src/libraries (@libraries)
|
|
|
|
|
|
|
|
[Pygments]: http://pygments.org/
|
|
Containing modules like infrastructure and basic mechanisms, like networking, and storage accessing
|
|
|
|
|
|
|
|
|
- Network
|
|
|
|
- Storage
|
|
|
|
|
|
|
|
Here's an example of some Python code:
|
|
## src/utils (@utils)
|
|
|
|
|
|
|
|
```
|
|
Util functions are located here
|
|
|
#!python
|
|
|
|
|
|
- obfuscator
|
|
|
|
- getty (SafeGet)
|
|
|
|
|
|
|
|
def wiki_rocks(text):
|
|
## src/defines (automatically imported)
|
|
|
formatter = lambda t: "funky"+t
|
|
|
|
|
return formatter(text)
|
|
TypeScript definitions are located here
|
|
|
|
|
|
|
|
- Auth (Auth package defines)
|
|
|
|
- Payloads (API request format defines)
|
|
|
|
- Response (API response format defines)
|
|
|
|
- Keys (Constant keys defines)
|
|
|
|
- Endpoints (API endpoints defines)
|
|
|
|
|
|
|
|
## Development
|
|
|
|
|
|
|
|
```sh
|
|
|
|
$ yarn start
|
|
|
|
# or
|
|
|
|
$ yarn run dev
|
|
|
```
|
|
```
|
|
|
|
|
|
|
|
|
## Testing
|
|
|
|
|
|
|
|
You can check out the source of this page to see how that's done, and make sure to bookmark [the vast library of Pygment lexers][lexers], we accept the 'short name' or the 'mimetype' of anything in there.
|
|
```sh
|
|
|
[lexers]: http://pygments.org/docs/lexers/
|
|
$ yarn test
|
|
|
|
```
|
|
|
|
|
|
|
|
|
## Build
|
|
|
|
|
|
|
|
Have fun! |
|
```sh
|
|
|
|
$ yarn run build
|
|
|
|
``` |
|
|
|
\ No newline at end of file |
