-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
1.0.0
- Loading branch information
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -13,3 +13,4 @@ | |
|
||
# Dependency directories (remove the comment below to include it) | ||
# vendor/ | ||
node_modules |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
# Developer's Guide | ||
|
||
We use Visual Studio Code for developing LoopBack and recommend the same to our | ||
users. | ||
|
||
## VSCode setup | ||
|
||
Install the following extensions: | ||
|
||
- [eslint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) | ||
- [prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) | ||
|
||
## Development workflow | ||
|
||
### Visual Studio Code | ||
|
||
1. Start the build task (Cmd+Shift+B) to run TypeScript compiler in the | ||
background, watching and recompiling files as you change them. Compilation | ||
errors will be shown in the VSCode's "PROBLEMS" window. | ||
|
||
2. Execute "Run Rest Task" from the Command Palette (Cmd+Shift+P) to re-run the | ||
test suite and lint the code for both programming and style errors. Linting | ||
errors will be shown in VSCode's "PROBLEMS" window. Failed tests are printed | ||
to terminal output only. | ||
|
||
### Other editors/IDEs | ||
|
||
1. Open a new terminal window/tab and start the continuous build process via | ||
`npm run build:watch`. It will run TypeScript compiler in watch mode, | ||
recompiling files as you change them. Any compilation errors will be printed | ||
to the terminal. | ||
|
||
2. In your main terminal window/tab, run `npm run test:dev` to re-run the test | ||
suite and lint the code for both programming and style errors. You should run | ||
this command manually whenever you have new changes to test. Test failures | ||
and linter errors will be printed to the terminal. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
# Check out https://hub.docker.com/_/node to select a new base image | ||
FROM node:10-slim | ||
|
||
RUN apt-get update && \ | ||
apt-get upgrade -y && \ | ||
apt-get install -y git | ||
|
||
# Set to a non-root built-in user `node` | ||
USER node | ||
|
||
# Create app directory (with user `node`) | ||
RUN mkdir -p /home/node/app | ||
|
||
WORKDIR /home/node/app | ||
# Install app dependencies | ||
# A wildcard is used to ensure both package.json AND package-lock.json are copied | ||
# where available (npm@5+) | ||
COPY --chown=node package*.json ./ | ||
|
||
RUN npm install | ||
|
||
# Bundle app source code | ||
COPY --chown=node . . | ||
|
||
# Remove .env so it doesn't conflict with passed in vars | ||
RUN rm .env | ||
|
||
RUN npm run build | ||
|
||
# Bind to all network interfaces so that it can be mapped to the host OS | ||
ENV HOST=0.0.0.0 PORT=3000 | ||
|
||
EXPOSE ${PORT} | ||
CMD [ "node", "." ] |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,87 +1,3 @@ | ||
<div align="center"> | ||
<a href="https://www.pokt.network"> | ||
<img src="https://user-images.githubusercontent.com/16605170/74199287-94f17680-4c18-11ea-9de2-b094fab91431.png" alt="Pocket Network logo" width="340"/> | ||
</a> | ||
</div> | ||
# pocket-gateway | ||
|
||
# Project Title | ||
|
||
One sentence summary of project | ||
<div> | ||
<a href="https://godoc.org/github.com/pokt-network/pocket-core"><img src="https://img.shields.io/badge/godoc-reference-blue.svg"/></a> | ||
<a href="https://goreportcard.com/report/github.com/pokt-network/pocket-core"><img src="https://goreportcard.com/badge/github.com/pokt-network/pocket-core"/></a> | ||
<a href="https://golang.org"><img src="https://img.shields.io/badge/golang-v1.11-red.svg"/></a> | ||
<a href="https://github.com/tools/godep" ><img src="https://img.shields.io/badge/godep-dependency-71a3d9.svg"/></a> | ||
</div> | ||
|
||
## Overview | ||
<div> | ||
<a href="https://github.com/pokt-network/pocket-core/releases"><img src="https://img.shields.io/github/release-pre/pokt-network/pocket-core.svg"/></a> | ||
<a href="https://circleci.com/gh/pokt-network/pocket-core/tree/staging"><img src="https://circleci.com/gh/pokt-network/pocket-core/tree/staging.svg?style=svg"/></a> | ||
<a href="https://github.com/pokt-network/pocket-core/pulse"><img src="https://img.shields.io/github/contributors/pokt-network/pocket-core.svg"/></a> | ||
<a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-blue.svg"/></a> | ||
<a href="https://github.com/pokt-network/pocket-core/pulse"><img src="https://img.shields.io/github/last-commit/pokt-network/pocket-core.svg"/></a> | ||
<a href="https://github.com/pokt-network/pocket-core/pulls"><img src="https://img.shields.io/github/issues-pr/pokt-network/pocket-core.svg"/></a> | ||
<a href="https://github.com/pokt-network/pocket-core/releases"><img src="https://img.shields.io/badge/platform-linux%20%7C%20windows%20%7C%20macos-pink.svg"/></a> | ||
<a href="https://github.com/pokt-network/pocket-core/issues"><img src="https://img.shields.io/github/issues-closed/pokt-network/pocket-core.svg"/></a> | ||
</div> | ||
|
||
Full Description | ||
|
||
## Getting Started | ||
|
||
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. | ||
|
||
### Example usage | ||
|
||
``` | ||
The most basic example of how you would use the project | ||
``` | ||
|
||
### Installation | ||
|
||
A step by step series of examples that tell you how to get a development env running | ||
|
||
Say what the step will be | ||
|
||
``` | ||
Give the step | ||
``` | ||
|
||
And repeat | ||
|
||
``` | ||
until finished | ||
``` | ||
|
||
End with an example of getting data out of the system or using it for a demo | ||
|
||
## Documentation | ||
|
||
Full usage and options or a link to the docs.pokt.network site | ||
|
||
## Running the tests | ||
|
||
Explain how to run the automated tests | ||
|
||
``` | ||
Give an example | ||
``` | ||
|
||
## Contributing | ||
|
||
Please read [CONTRIBUTING.md](https://github.com/pokt-network/repo-template/blob/master/CONTRIBUTING.md) for details on contributions and the process of submitting pull requests. | ||
|
||
## Support & Contact | ||
|
||
<div> | ||
<a href="https://twitter.com/poktnetwork" ><img src="https://img.shields.io/twitter/url/http/shields.io.svg?style=social"></a> | ||
<a href="https://t.me/POKTnetwork"><img src="https://img.shields.io/badge/Telegram-blue.svg"></a> | ||
<a href="https://www.facebook.com/POKTnetwork" ><img src="https://img.shields.io/badge/Facebook-red.svg"></a> | ||
<a href="https://research.pokt.network"><img src="https://img.shields.io/discourse/https/research.pokt.network/posts.svg"></a> | ||
</div> | ||
|
||
|
||
## License | ||
|
||
This project is licensed under the MIT License; see the [LICENSE.md](LICENSE.md) file for details. | ||
[![LoopBack](https://github.com/strongloop/loopback-next/raw/master/docs/site/imgs/branding/Powered-by-LoopBack-Badge-(blue)[email protected])](http://loopback.io/) |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
export {}; |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
export {}; |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
import { PocketGatewayApplication } from '../..'; | ||
import { Client } from '@loopback/testlab'; | ||
export declare function setupApplication(): Promise<AppWithClient>; | ||
export interface AppWithClient { | ||
app: PocketGatewayApplication; | ||
client: Client; | ||
} |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
import { ApplicationConfig } from '@loopback/core'; | ||
import { RestApplication } from '@loopback/rest'; | ||
declare const PocketGatewayApplication_base: (new (...args: any[]) => { | ||
[x: string]: any; | ||
projectRoot: string; | ||
bootOptions?: import("@loopback/boot").BootOptions | undefined; | ||
boot(): Promise<void>; | ||
booters(...booterCls: import("@loopback/core").Constructor<import("@loopback/boot").Booter>[]): import("@loopback/boot").Binding<any>[]; | ||
component(component: import("@loopback/core").Constructor<{}>): void; | ||
mountComponentBooters(component: import("@loopback/core").Constructor<{}>): void; | ||
}) & (new (...args: any[]) => { | ||
[x: string]: any; | ||
serviceProvider<S>(provider: import("@loopback/service-proxy").Class<import("@loopback/core").Provider<S>>, name?: string | undefined): import("@loopback/boot").Binding<S>; | ||
component(component: import("@loopback/service-proxy").Class<unknown>, name?: string | undefined): void; | ||
mountComponentServices(component: import("@loopback/service-proxy").Class<unknown>): void; | ||
}) & (new (...args: any[]) => { | ||
[x: string]: any; | ||
repository<R extends import("@loopback/repository").Repository<any>>(repoClass: import("@loopback/repository").Class<R>, name?: string | undefined): import("@loopback/boot").Binding<R>; | ||
getRepository<R_1 extends import("@loopback/repository").Repository<any>>(repo: import("@loopback/repository").Class<R_1>): Promise<R_1>; | ||
dataSource<D extends import("loopback-datasource-juggler").DataSource>(dataSource: D | import("@loopback/repository").Class<D>, name?: string | undefined): import("@loopback/boot").Binding<D>; | ||
component(component: import("@loopback/repository").Class<unknown>, name?: string | undefined): void; | ||
mountComponentRepositories(component: import("@loopback/repository").Class<unknown>): void; | ||
migrateSchema(options?: import("@loopback/repository").SchemaMigrationOptions | undefined): Promise<void>; | ||
}) & typeof RestApplication; | ||
export declare class PocketGatewayApplication extends PocketGatewayApplication_base { | ||
constructor(options?: ApplicationConfig); | ||
loadPocket(): Promise<void>; | ||
} | ||
export {}; |