Skip to content

Commit

Permalink
Explorer 2.0 (#489)
Browse files Browse the repository at this point in the history
  • Loading branch information
lautarodragan authored Jan 28, 2019
1 parent def3c17 commit 0d8f432
Show file tree
Hide file tree
Showing 212 changed files with 7,290 additions and 24,506 deletions.
3 changes: 3 additions & 0 deletions .babelrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"presets": ["@babel/preset-env", "@babel/preset-react"]
}
4 changes: 0 additions & 4 deletions .dockerignore

This file was deleted.

2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@

### Warning

Merging to `master` automatically triggers a deploy in production.
Merging to `master` automatically triggers a deploy to QA.
29 changes: 0 additions & 29 deletions .nycrc

This file was deleted.

25 changes: 0 additions & 25 deletions .renovaterc.json

This file was deleted.

2 changes: 0 additions & 2 deletions .storybook/addons.js

This file was deleted.

15 changes: 0 additions & 15 deletions .storybook/config.js

This file was deleted.

37 changes: 0 additions & 37 deletions .storybook/webpack.config.js

This file was deleted.

24 changes: 0 additions & 24 deletions .storybook/welcomeStory.js

This file was deleted.

5 changes: 0 additions & 5 deletions .stylelintrc

This file was deleted.

5 changes: 0 additions & 5 deletions .travis.yml

This file was deleted.

17 changes: 0 additions & 17 deletions Dockerfile

This file was deleted.

2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2017-2018 The Po.et Foundation
Copyright (c) 2017-2019 The Po.et Foundation

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
51 changes: 9 additions & 42 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,11 @@
# Explorer Web

[![Build Status](https://travis-ci.org/poetapp/explorer-web.svg?branch=master)](https://travis-ci.org/poetapp/explorer-web)
[![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com/)
[![Join the chat at https://gitter.im/poetapp/Lobby](https://badges.gitter.im/poetapp/Lobby.svg)](https://gitter.im/poetapp/Lobby)

Po.et's web application to view claims on the Po.et Network
Po.et's web application to view claims on the Po.et Network.

## Development Process
All new features should be merged into master behind a feature toggle with it turned off by default. Once the feature has been sufficiently tested the toggle can be removed.

## Libraries, Frameworks, etc.
- Typescript
- ReactJS
- React Redux
- Redux-Saga
- Webpack
- [frost-client](https://github.com/poetapp/frost-client)
- [poet-js](https://github.com/poetapp/poet-js)
All new features should be merged into master behind a feature toggle with it turned off by default.

## File Structure

Expand All @@ -28,40 +17,18 @@ Most components have a single associated `.scss` file with the same name. There

Components are divided in atoms, molecules, organisms, pages and modals. Rule of thumb is: the smaller shouldn't use the larger. That means atoms should have no dependencies on other components, molecules can only depend on atoms and so on.

Pages are currently living outside `/components` for historic reasons, but they'll be moved into this folder in the future.

The root component is [components/Root.tsx](./src/components/Root.tsx) and ReactDOM.render is called in [index.tsx](./src/index.tsx).

## Reducers

React Redux reducers live here. They shouldn't have any logic at all, just receive messages and update the redux store.

## Sagas

Redux-Saga sagas live here. Most of the application's logic, specifically all of the side effects, should be in sagas and sagas only.
The root component is [components/Root.jsx](./src/components/Root.jsx) and ReactDOM.render is called in [index.jsx](./src/index.jsx).

## Images

All images used by the application. They are exposed as `static readonly` elements of a class in [images/Images.tsx](./src/images/Images.tsx), using the File Loader Webpack plugin to load and bundle them.

## Extensions

Extensions to JavaScript's native types go here.
TBD

# Coding Standard

We mostly follow [StandardJS](https://standardjs.com/) and [AirBnB's JS Style Guide](https://github.com/airbnb/javascript). We're not automatically enforcing styles yet.
All images used by the application. They are exposed as `static readonly` elements of a class in [images/Images.tsx](./src/images/Images.tsx), using the File Loader Webpack plugin to load and bundle them.

Some rules:
## Contributing

- **Write pure functional code**, side-effect-less, as much as possible. That means `var` is forbidden, and `let` should be avoided whenever possible - always use `const` instead.
- **Write small functions with clear purposes**
- **Avoid default exports**
- **Name files** following AirBnB's rules [23.6](https://github.com/airbnb/javascript#naming--filename-matches-export), [23.7](https://github.com/airbnb/javascript#naming--camelCase-default-export), and [23.8](https://github.com/airbnb/javascript#naming--PascalCase-singleton), applying to the most important export rather than the default export
- **Use 2 spaces** for indentation
- **Use single quotes** for strings except to avoid escaping
- **Add a space after keywords**
See [Contributing](https://github.com/poetapp/documentation/blob/master/CONTRIBUTING.md).

## [Contributing](https://github.com/poetapp/documentation/blob/master/CONTRIBUTING.md)
## Security

## [Security](https://github.com/poetapp/documentation/blob/master/SECURITY.md)
See [Security](https://github.com/poetapp/documentation/blob/master/SECURITY.md).
7 changes: 0 additions & 7 deletions _headers

This file was deleted.

27 changes: 0 additions & 27 deletions devServer.js

This file was deleted.

18 changes: 4 additions & 14 deletions netlify.toml
Original file line number Diff line number Diff line change
@@ -1,23 +1,13 @@
# Global settings applied to the whole site.
#
# “publish” is the directory to publish (relative to root of your repo),
# “command” is your build command,
# “base” is directory to change to before starting build. if you set base:
# that is where we will look for package.json/.nvmrc/etc not repo root!
# Global settings applied to the whole site.

[build]
publish = "dist"

# Production context: All deploys to the main
# repository branch will inherit these settings.

# Deploy Preview context: All Deploy Previews
# will inherit these settings.
[context.deploy-preview]
command = "npm run build:qaRegtest"
command = "npm run build"

[context.testing]
command = "npm run build:qaRegtest"
command = "npm run build"

[context.branch-deploy]
command = "npm run build:qaRegtest"
command = "npm run build"
Loading

0 comments on commit 0d8f432

Please sign in to comment.