Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add Architecture.md file #9180

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
28 changes: 28 additions & 0 deletions docs/.dockerignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# See https://help.github.com/ignore-files/ for more about ignoring files.

# compiled output
dist
tmp

# dependencies
node_modules
bower_components
Dockerfile

# misc
/.sass-cache
/connect.lock
/coverage/*
/libpeerconnection.log
npm-debug.log*
testem.log
/public/assets/locales/
*~
/kubernetes/images/frontend/deploy-dist/
/kubernetes/images/frontend/node_Modules/
.idea
.git
docs
kubernetes
tests
/yarn-error.log
20 changes: 20 additions & 0 deletions docs/.editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# EditorConfig helps developers define and maintain consistent
# coding styles between different editors and IDEs
# editorconfig.org

root = true


[*]
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true
indent_style = space
indent_size = 2

[*.hbs]
insert_final_newline = false

[*.{diff,md}]
trim_trailing_whitespace = false
9 changes: 9 additions & 0 deletions docs/.ember-cli
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
/**
Ember CLI sends analytics information by default. The data is completely
anonymous, but there are times when you might want to disable this behavior.

Setting `disableAnalytics` to true will prevent any data from being sent.
*/
"disableAnalytics": false
}
5 changes: 5 additions & 0 deletions docs/.env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
#MAPBOX_ACCESS_TOKEN = "Access Token"
API_HOST=https://test-api.eventyay.com
MAP_DISPLAY=embed
FASTBOOT_DISABLED=true
#HCAPTCHA_SITE_KEY=""
2 changes: 2 additions & 0 deletions docs/.eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
vendor
app/utils/l10n-fingerprint-map.js
146 changes: 146 additions & 0 deletions docs/.eslintrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,146 @@
const config = {
root: true,
parser: 'babel-eslint',
parserOptions: {
ecmaVersion: 2017,
sourceType: 'module',
ecmaFeatures: { legacyDecorators: true },
},
plugins: [
'ember',
'ember-suave'
],
extends: [
'eslint:recommended',
'plugin:ember-suave/recommended'
],
env: {
es6: true,
browser: true
},
rules: {
'arrow-spacing': 'error',
'no-var': 'error',
'no-useless-escape': 'off',
'space-before-blocks': 'error',
'comma-dangle': ['error', 'never'],
'space-in-parens': ['error', 'never'],
'space-before-function-paren': ['error', 'never'],
'comma-spacing': ['error', { 'before': false, 'after': true }],
'semi': ['error', 'always', {'omitLastInOneLineBlock': true}],
'semi-spacing': ['error', {'before': false, 'after': true}],
'keyword-spacing': ['error', { 'before': true, 'after': true }],
'spaced-comment': ['error', 'always'],
'object-shorthand': ['error', 'always'],
'dot-notation': 'error',
'arrow-parens': ['error', 'as-needed'],
'object-curly-spacing': ['error', 'always'],
'space-infix-ops': 'error',
'no-multiple-empty-lines': ['error', { 'max': 2, 'maxEOF': 1 }],
'key-spacing': [
'error', {
'align': {
'beforeColon': true,
'afterColon': true,
'on': 'colon'
}
}
],
'operator-linebreak': ['error', 'before'],
'array-bracket-spacing': ['error', 'never'],
'no-trailing-spaces': 'error',
'brace-style': ['error', '1tbs', { 'allowSingleLine': true }],
'max-statements-per-line': ['error', { 'max': 2 }],
'quotes': ['error', 'single'],
'indent': [
'error', 2, {
"FunctionExpression": {"parameters": "first"},
"FunctionDeclaration": {"parameters": "first"},
"MemberExpression": 1,
"SwitchCase": 1,
"outerIIFEBody": 0,
"VariableDeclarator": { "var": 2, "let": 2, "const": 3 }
}
],
'no-console': ["error", { allow: ["warn", "error"] }],
'prefer-template': 'off',
'prefer-rest-params': 'off',
'camelcase': 'off',
'eqeqeq': ['error', 'smart'],
"prefer-const": ["error", {
"destructuring": "any",
"ignoreReadBeforeAssign": false
}],
'padding-line-between-statements': 'off',
'lines-between-class-members': ['error', "always", { exceptAfterSingleLine: true }],
'ember-suave/no-const-outside-module-scope': 'off',
'ember-suave/require-access-in-comments': 'off',
'ember-suave/lines-between-object-properties': 'off',
},
globals: {
module : true,
process : true,
wysihtml5 : true,
palette : true,
Uint8Array : true,
require : true,
Promise : true
},
overrides: [
// node files
{
files: [
'.eslintrc.js',
'.template-lintrc.js',
'ember-cli-build.js',
'testem.js',
'blueprints/*/index.js',
'config/**/*.js',
'lib/*/index.js',
'server/**/*.js'
],
parserOptions: {
sourceType: 'script',
ecmaVersion: 2015
},
env: {
browser: false,
node: true
},
plugins: ['node'],
rules: Object.assign({}, require('eslint-plugin-node').configs.recommended.rules, {
// add your custom rules and overrides for node files here

// this can be removed once the following is fixed
// https://github.com/mysticatea/eslint-plugin-node/issues/77
'node/no-unpublished-require': 'off',
'node/no-extraneous-require': 'off'
})
}
]
};

config.overrides.push({
files: ['**/*.ts'],
parser: '@typescript-eslint/parser',
parserOptions: config.parserOptions,
plugins: [
...config.plugins,
'@typescript-eslint'
],
extends: [
...config.extends,
"plugin:@typescript-eslint/eslint-recommended",
"plugin:@typescript-eslint/recommended"
],
env: config.env,
rules: {
...config.rules,
"@typescript-eslint/no-unused-vars": ["error"],
'@typescript-eslint/no-explicit-any': 'off',
'semi': 'off'
},
globals: config.globals
})

module.exports = config;
16 changes: 16 additions & 0 deletions docs/.github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
## Contributions Best Practices

**Commits**
* Write clear meaningful git commit messages (Do read https://chris.beams.io/posts/git-commit/)
* Make sure your PR's description contains GitHub's special keyword references that automatically close the related issue when the PR is merged. (More info at https://github.com/blog/1506-closing-issues-via-pull-requests )
* When you make very very minor changes to a PR of yours (like for example fixing a failing travis build or some small style corrections or minor changes requested by reviewers) make sure you squash your commits afterwards so that you don't have an absurd number of commits for a very small fix. (Learn how to squash at https://davidwalsh.name/squash-commits-git )
* When you're submitting a PR for a UI-related issue, it would be really awesome if you add a screenshot of your change or a link to a deployment where it can be tested out along with your PR. It makes it very easy for the reviewers and you'll also get reviews quicker.

**Feature Requests and Bug Reports**
* When you file a feature request or when you are submitting a bug report to the [issue tracker](https://github.com/fossasia/open-event-frontend/issues), make sure you add steps to reproduce it. Especially if that bug is some weird/rare one.

**Join the development**
* Before you join development, please [set up the project on your local machine](/docs/installation/local.md), run it and go through the application completely. Press on any button you can find and see where it leads to. Explore. (Don't worry ... Nothing will happen to the app or to you due to the exploring :wink: Only thing that will happen is, you'll be more familiar with what is where and might even get some cool ideas on how to improve various aspects of the app.)
* If you would like to work on an issue, drop in a comment at the issue. If it is already assigned to someone, but there is no sign of any work being done, please free to drop in a comment so that the issue can be assigned to you if the previous assignee has dropped it entirely.

Do read the [Open Source Developer Guide and Best Practices at FOSSASIA](https://blog.fossasia.org/open-source-developer-guide-and-best-practices-at-fossasia).
35 changes: 35 additions & 0 deletions docs/.github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
name: Bug report
about: Create a report to help us improve

---

**Describe the bug**
<!-- A clear and concise description of what the bug is. -->

**To Reproduce**
Steps to reproduce the behaviour:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behaviour**
<!-- A clear and concise description of what you expected to happen. -->

**Screenshots**
<!-- If applicable, add screenshots to help explain your problem. -->

**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]

**Smartphone (please complete the following information):**
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]

**Additional context**
<!-- Add any other context about the problem here. -->
17 changes: 17 additions & 0 deletions docs/.github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
name: Feature request
about: Suggest an idea for this project

---

**Is your feature request related to a problem? Please describe.**
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->

**Describe the solution you'd like**
<!-- A clear and concise description of what you want to happen. -->

**Describe alternatives you've considered**
<!-- A clear and concise description of any alternative solutions or features you've considered. -->

**Additional context**
<!-- Add any other context or screenshots about the feature request here. -->
24 changes: 24 additions & 0 deletions docs/.github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<!--
(Thanks for sending a pull request! Please make sure you click the link above to view the contribution guidelines, then fill out the blanks below.)
-->

<!-- Add the issue number that is fixed by this PR (In the form Fixes #123) -->

Fixes #

#### Short description of what this resolves:


#### Changes proposed in this pull request:

-
-
-

#### Checklist

- [ ] I have read the [Contribution & Best practices Guide](https://blog.fossasia.org/open-source-developer-guide-and-best-practices-at-fossasia).
- [ ] My branch is up-to-date with the Upstream `development` branch.
- [ ] The acceptance, integration, unit tests and linter pass locally with my changes <!-- use `ember test` to run all the tests -->
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] I have added necessary documentation (if appropriate)
Loading
Loading