feat: initiate project

Author: thetutlage

.circleci/config.yml

@@ -0,0 +1,40 @@
+version: 2
+jobs:
+  build_10.15.3:
+    docker:
+      - image: 'circleci/node:10.15.3'
+    working_directory: ~/app
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+            - 'v1-dependencies-{{ checksum "package.json" }}'
+            - v1-dependencies-
+      - run: npm install
+      - save_cache:
+          paths:
+            - node_modules
+          key: 'v1-dependencies-{{ checksum "package.json" }}'
+      - run: npm test
+  build_latest:
+    docker:
+      - image: 'circleci/node:latest'
+    working_directory: ~/app
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+            - 'v1-dependencies-{{ checksum "package.json" }}'
+            - v1-dependencies-
+      - run: npm install
+      - save_cache:
+          paths:
+            - node_modules
+          key: 'v1-dependencies-{{ checksum "package.json" }}'
+      - run: npm test
+workflows:
+  version: 2
+  workflow:
+    jobs:
+      - build_10.15.3
+      - build_latest

.editorconfig

@@ -0,0 +1,22 @@
+# http://editorconfig.org
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.json]
+insert_final_newline = ignore
+
+[**.min.js]
+indent_style = ignore
+insert_final_newline = ignore
+
+[MakeFile]
+indent_style = tab
+
+[*.md]
+trim_trailing_whitespace = false

.github/COMMIT_CONVENTION.md

@@ -0,0 +1,70 @@
+## Git Commit Message Convention
+
+> This is adapted from [Angular's commit convention](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular).
+
+Using conventional commit messages, we can automate the process of generating the CHANGELOG file. All commits messages will automatically be validated against the following regex.
+
+``` js
+/^(revert: )?(feat|fix|docs|style|refactor|perf|test|workflow|ci|chore|types|build)((.+))?: .{1,50}/
+```
+
+## Commit Message Format
+A commit message consists of a **header**, **body** and **footer**. The header has a **type**, **scope** and **subject**:
+
+> The **scope** is optional
+
+```
+feat(router): add support for prefix
+
+Prefix makes it easier to append a path to a group of routes
+```
+
+1. `feat` is type.
+2. `router` is scope and is optional
+3. `add support for prefix` is the subject
+4. The **body** is followed by a blank line.
+5. The optional **footer** can be added after the body, followed by a blank line.
+
+## Types
+Only one type can be used at a time and only following types are allowed.
+
+- feat
+- fix
+- docs
+- style
+- refactor
+- perf
+- test
+- workflow
+- ci
+- chore
+- types
+- build
+
+If a type is `feat`, `fix` or `perf`, then the commit will appear in the CHANGELOG.md file. However if there is any BREAKING CHANGE, the commit will always appear in the changelog.
+
+### Revert
+If the commit reverts a previous commit, it should begin with `revert:`, followed by the header of the reverted commit. In the body it should say: `This reverts commit <hash>`., where the hash is the SHA of the commit being reverted.
+
+## Scope
+The scope could be anything specifying place of the commit change. For example: `router`, `view`, `querybuilder`, `database`, `model` and so on.
+
+## Subject
+The subject contains succinct description of the change:
+
+- use the imperative, present tense: "change" not "changed" nor "changes".
+- don't capitalize first letter
+- no dot (.) at the end
+
+## Body
+
+Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes".
+The body should include the motivation for the change and contrast this with previous behavior.
+
+## Footer
+
+The footer should contain any information about **Breaking Changes** and is also the place to
+reference GitHub issues that this commit **Closes**.
+
+**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this.
+

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,29 @@
+---
+name: Bug report
+about: Report identified bugs
+---
+
+<!-- CLICK "Preview" FOR INSTRUCTIONS IN A MORE READABLE FORMAT -->
+
+## Prerequisites
+
+We do our best to reply to all the issues on time. If you will follow the given guidelines, the turn around time will be faster.
+
+- Lots of raised issues are directly not bugs but instead are design decisions taken by us.
+- Make use of our [forum](https://forum.adonisjs.com/), or [discord server](https://discord.me/adonisjs), if you are not sure that you are reporting a bug.
+- Ensure the issue isn't already reported.
+- Ensure you are reporting the bug in the correct repo.
+
+*Delete the above section and the instructions in the sections below before submitting*
+
+## Package version
+<!-- YOUR ANSWER -->
+
+## Node.js and npm version
+<!-- YOUR ANSWER -->
+
+## Sample Code (to reproduce the issue)
+<!-- YOUR ANSWER -->
+
+## BONUS (a sample repo to reproduce the issue)
+<!-- YOUR ANSWER -->

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,28 @@
+---
+name: Feature request
+about: Propose changes for adding a new feature
+---
+
+<!-- CLICK "Preview" FOR INSTRUCTIONS IN A MORE READABLE FORMAT -->
+
+## Prerequisites
+
+We do our best to reply to all the issues on time. If you will follow the given guidelines, the turn around time will be faster.
+
+## Consider an RFC
+
+Please create an [RFC](https://github.com/adonisjs/rfcs) instead, if
+
+- Feature introduces a breaking change
+- Demands lots of time and changes in the current code base.
+
+*Delete the above section and the instructions in the sections below before submitting*
+
+## Why this feature is required (specific use-cases will be appreciated)?
+<!-- YOUR ANSWER -->
+
+## Have you tried any other work arounds?
+<!-- YOUR ANSWER -->
+
+## Are you willing to work on it with little guidance?
+<!-- YOUR ANSWER -->

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,28 @@
+<!-- CLICK "Preview" FOR INSTRUCTIONS IN A MORE READABLE FORMAT -->
+
+## Proposed changes
+
+Describe the big picture of your changes here to communicate to the maintainers why we should accept this pull request. If it fixes a bug or resolves a feature request, be sure to link to that issue.
+
+## Types of changes
+
+What types of changes does your code introduce?
+
+_Put an `x` in the boxes that apply_
+
+- [ ] Bugfix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+
+## Checklist
+
+_Put an `x` in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code._
+
+- [ ] I have read the [CONTRIBUTING](https://github.com/[email protected]/adonisjs/blob/assembler.git/CONTRIBUTING.md) doc
+- [ ] Lint and unit tests pass locally with my changes
+- [ ] I have added tests that prove my fix is effective or that my feature works.
+- [ ] I have added necessary documentation (if appropriate)
+
+## Further comments
+
+If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc...

.gitignore

@@ -0,0 +1,14 @@
+node_modules
+coverage
+.DS_STORE
+.nyc_output
+.idea
+.vscode/
+*.sublime-project
+*.sublime-workspace
+*.log
+build
+dist
+yarn.lock
+shrinkwrap.yaml
+package-lock.json

.npmrc

@@ -0,0 +1 @@
+message="chore(release): %s"

CONTRIBUTING.md

@@ -0,0 +1,48 @@
+# Contributing
+
+AdonisJs is a community driven project. You are free to contribute in any of the following ways.
+
+- [Coding style](coding-style)
+- [Fix bugs by creating PR's](fix-bugs-by-creating-prs)
+- [Share an RFC for new features or big changes](share-an-rfc-for-new-features-or-big-changes)
+- [Report security issues](report-security-issues)
+- [Be a part of the community](be-a-part-of-community)
+
+## Coding style
+
+Majority of AdonisJs core packages are written in Typescript. Having a brief knowledge of Typescript is required to contribute to the core. [Learn more](https://adonisjs.com/coding-style) about the same.
+
+## Fix bugs by creating PR's
+
+We appreciate every time you report a bug in the framework or related libraries. However, taking time to submit a PR can help us in fixing bugs quickly and ensure a healthy and stable eco-system.
+
+Go through the following points, before creating a new PR.
+
+1. Create an issue discussing the bug or short-coming in the framework.
+2. Once approved, go ahead and fork the REPO.
+3. Make sure to start from the `develop`, since this is the upto date branch.
+4. Make sure to keep commits small and relevant.
+5. We follow [conventional-commits](https://github.com/conventional-changelog/conventional-changelog) to structure our commit messages. Instead of running `git commit`, you must run `npm commit`, which will show you prompts to create a valid commit message.
+6. Once done with all the changes, create a PR against the `develop` branch.
+
+## Share an RFC for new features or big changes
+
+Sharing PR's for small changes works great. However, when contributing big features to the framework, it is required to go through the RFC process.
+
+### What is an RFC?
+
+RFC stands for **Request for Commits**, a standard process followed by many other frameworks including [Ember](https://github.com/emberjs/rfcs), [yarn](https://github.com/yarnpkg/rfcs) and [rust](https://github.com/rust-lang/rfcs). 
+
+In brief, RFC process allows you to talk about the changes with everyone in the community and get a view of the core team before dedicating your time to work on the feature.
+
+The RFC proposals are created as issues on [adonisjs/rfcs](https://github.com/adonisjs/rfcs) repo. Make sure to read the README to learn about the process in depth.
+
+## Report security issues
+
+All of the security issues, must be reported via [email](mailto:[email protected]) and not using any of the public channels. [Learn more](https://adonisjs.com/security) about the security policy
+
+## Be a part of community
+
+We welcome you to participate in the [forum](https://forum.adonisjs.com/) and the AdonisJs [discord server](https://discord.me/adonisjs). You are free to ask your questions and share your work or contributions made to AdonisJs eco-system. 
+
+We follow a strict [Code of Conduct](https://adonisjs.com/community-guidelines) to make sure everyone is respectful to each other.

LICENSE.md

@@ -0,0 +1,9 @@
+# The MIT License
+
+Copyright 2019 Harminder virk, contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.