Skip to content

Commit

Permalink
[chore] init commit 🔥
Browse files Browse the repository at this point in the history
  • Loading branch information
scott-wyatt committed Jun 18, 2018
0 parents commit 2b40da5
Show file tree
Hide file tree
Showing 129 changed files with 5,028 additions and 0 deletions.
99 changes: 99 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
# Contributing to Fabrix-app and Spools

This guide is designed to help you get off the ground quickly contributing to Fabrix, Spools and the Fabrix ecosystem. The goal of our community is to make it easy for members of all skill levels to contribute. This guide will help you write useful issues, propose eloquent feature requests, and submit top-notch code that can be merged quickly.

Maintaining a open source project is a labor of love, meaning the core maintainers of Fabrix or Spools are volunteering their time. Respecting the guidelines laid out below helps the maintainers be efficient and make the most of the time they spend working on the project. This, in turn, creates a better experience of working with Fabrix more enjoyable for the community at large.


## Submitting Issues

> Fabrix is composed of a core library, [Fabrix](https://github.com/fabrix-app/fabrix), and a number of [Spools](https://github.com/fabrix-app), which have their own dedicated repositories. These repositories may also live outside the Fabrix-app official Github organization.
>
> _*Please open issues with spools, generators, etc. in the relevant repository.*_
>
> This helps us stay on top of issues and keep organized.
When submitting an issue, please follow these simple instructions:

1. Search for issues similar to yours in [GitHub search](https://github.com/fabrix-app/fabrix/search?type=Issues) and [Google](https://www.google.nl/search?q=fabrix+app).
2. Feature requests are welcome; see [Requesting Features](#requesting-features) below for submission guidelines.
3. If there's an open issue, please contribute to that issue.
4. If there's a closed issue, open a new issue and link the url of the already closed issue(s).
5. If there is no issue, open a new issue and specify the following:
- A short description of your issue in the title
- The fabrix version (find this with in the package.json file)
- Detailed explanation of how to recreate the issue, including necessary setup setps
6. If you are experiencing more than one problem, create a separate issue for each one. If you think they might be related, please reference the other issues you've created.



## Submitting Features

> New feature requests should be made as pull requests to the `backlog` section of [ROADMAP.MD](https://github.com/fabrix-app/fabrix/blob/master/ROADMAP.md) or as issues on the `Backlog` milestone in the [issue queue](https://github.com/fabrix-app/fabrix/milestones/Backlog). We will monitor community discussion on these PRs and issues and if they are wanted by the community/fabrix devs, they will be merged. Further discussion is welcome even after a PR has been merged.
##### Submitting a new feature request
1. First, look at the `backlog` table in [ROADMAP.MD](https://github.com/fabrix-app/fabrix/blob/master/ROADMAP.md) or the [Backlog Milestone](https://github.com/fabrix-app/fabrix/milestones/Backlog) in the issue queue toand also search open pull requests in that file to make sure your change hasn't already been proposed. If it has, join the discussion.
2. If it doesn't already exist, create a pull request editing the `backlog` table of [ROADMAP.MD](https://github.com/fabrix-app/fabrix/blob/master/ROADMAP.md).
3. Start a discussion about why your feature should be built (or better yet, build it). Get feedback in the [Fabrix.js Gitter](https://gitter.im/fabrix-app/fabrix) Channel. The more feedback we get from our community, the better we are able to build the framework of your dreams :evergreen_tree:

## Writing Tests

Ideally, all code contributions should be accompanied by functional and/or unit tests (as appropriate).

Test Coverage:

| Edge (master branch) |
|----------------------|
| [![Coverage Status](https://coveralls.io/repos/fabrix-app/fabrix/badge.png)](https://coveralls.io/r/fabrix-app/fabrix) |


## Code Submission Guidelines

The community is what makes Fabrix great, without you we wouldn't have come so far. But to help us keep our sanity and reach code-nirvana together, please follow these quick rules whenever contributing.

> Note: This section is based on the [Node.js contribution guide](https://github.com/joyent/node/blob/master/CONTRIBUTING.md#contributing).
###### Contributing to an Spool

If the Spool is in the Fabrix Github organization, please send feature requests, patches and pull requests to that organization. Other Spools may have their own contribution guidelines. Please follow the guidelines of the Spool you are contributing to.

###### Authoring a new Spool

You are welcome to author a new Spool at any time. Spools must inherit from the main [Spool](https://github.com/fabrix-app/fabrix) interface to inherit the API. Feel free to start work on a new spool, just make sure and do a thorough search on npm, Google and Github to make sure someone else hasn't already started working on the same thing.

It is recommended that you maintain your Spool in your own Github repository. If you would like to submit your Spool to be listed in the [Fabrix-app Github Organization](https://github.com/fabrix-app), please submit an issue to the [Fabrix Issue queue](https://github.com/fabrix-app/fabrix/issues).

###### Contributing to a generator

Fabrix generators are based upon a cli. Please follow the core best practices for contributing to generators. If it is located in a different repo, please send feature requests, patches, and issues there.

###### Contributing to core

Fabrix has several dependencies referenced in the `package.json` file that are not part of the project proper. Any proposed changes to those dependencies or _their_ dependencies should be sent to their respective projects (i.e. Sequelize etc.) Please do not send your patch or feature request to this repository, we cannot accept or fulfill it.

In case of doubt, open an issue in the [issue tracker](https://github.com/fabrix-app/fabrix/issues), ask your question in the [Gitter room](http://gitter.im/fabrix-app/fabrix). Especially if you plan to work on something big. Nothing is more frustrating than seeing your hard work go to waste because your vision does not align with a project's roadmap. At the end of the day, we just want to be able to merge your code.

###### Submitting Pull Requests

0. If you don't know how to fork and PR, [Github has some great documentation](https://help.github.com/articles/using-pull-requests/). Here's the quick version:
1. Fork the repo.
2. Add a test for your change. Only refactoring and documentation changes require no new tests. If you are adding functionality or fixing a bug, we need a test!
4. Make the tests pass and make sure you follow our syntax guidelines.
5. Add a line of what you did to CHANGELOG.md (right under `master`).
6. Push to your fork and submit a pull request to the appropriate branch

## Publishing Releases

All releases are tagged and published by the [Fabrix.js Maintainers](https://github.com/orgs/fabrix-app/teams) automatically via [Travis-CI](https://travis-ci.org/fabrix-app/fabrix). For a patch release, the deployment process is as follows:

1. Tag a release
```sh
$ npm version patch
```

2. Push the tag upstream (the "fabrix-app" org)
```sh
$ git push upstream --tags
```

3. Circle-CI will publish the release to npm.
7 changes: 7 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
#### Issue Description
???

#### Environment
- node version: ???
- fabrix version: ???
- operating system: ???
5 changes: 5 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
#### Description
???

#### Issues
- resolves #???
39 changes: 39 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Compiled version placed here by typescript compiler
dist

/.idea
# Logs
logs
*.log

# Tmp
.tmp

# Runtime data
pids
*.pid
*.seed

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

# Coverage directory used by tools like istanbul
coverage
.nyc_output

# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# node-waf configuration
.lock-wscript

# Compiled binary addons (http://nodejs.org/api/addons.html)
build/Release

# Dependency directory
# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
node_modules

*.sw*
package-lock.json
yarn.lock
12 changes: 12 additions & 0 deletions .istanbul.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
instrumentation:
root: .
# Include all source files so we know which files are not tested at all
include-all-sources: true
excludes: [ 'test/**', 'test-performance/**' ]

reporting:
reports:
# Lcov output can be used by some other program, and the html report can be viewed by humans in
# browser - coverage/lcov-report/index.html
- lcov
9 changes: 9 additions & 0 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
.github/
.tmp/
.nyc_output/
test/
test-performance/

.istanbul.yml
.travis.yml
appveyor.yml
23 changes: 23 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
The MIT License (MIT)

Copyright (c) 2018 CST <info@cali-style.com>
2018 Scott Wyatt <scottwyatt86@gmail.com>

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.

120 changes: 120 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
<img src="http://cdn.fabrix.app/art/logos/fabrix-horiz-logo-green.svg" height="96px" title="Fabrix Logo" />

[![Gitter][gitter-image]][gitter-url]
[![NPM version][npm-image]][npm-url]
[![Linux + OSX Build Status][ci-image]][ci-url]
[![Windows Build Status][appveyor-image]][appveyor-url]
[![Test Coverage][coverage-image]][coverage-url]
[![Follow @fabrix-app on Twitter][twitter-image]][twitter-url]

Fabrix is a strongly typed modern, [community-driven](https://opencollective.com/fabrix) web application framework for Node.js. It
builds on the pedigree of [Rails](http://rubyonrails.org/) and [Grails](https://grails.org/)
to accelerate development by adhering to a straightforward, convention-based,
API-driven design philosophy.

## Getting Started

#### Install

```sh
$
```

#### Trailblaze

Fabrix uses a CLI to generate scaffolding for new
applications, and to create resources inside the application.

```sh
$ fab --help

Usage:
fab

Generators:

Create New Model
fab model <model-name>

Create New Controller
fab controller <controller-name>

Create New Policy
fab policy <policy-name>

Create New Service
fab service <service-name>
```

#### Run

Once installation is complete, begin your journey!
```sh
$ node server.js
```

#### Happy Fabrix!

## Spools

[Spools](https://github.com/fabrix-app/spool) extend the framework's
capabilities and allow developers to leverage existing ecosystem tools through a
simple and well-defined API. New features, behavior, APIs, and other functionality
can be added to the Fabrix framework through Spools.

Many Fabrix installations will include some of the following Spools:

- [router](https://github.com/fabrix-app/spool-router)
- [repl](https://github.com/fabrix-app/spool-repl)
- [express](https://github.com/fabrix-app/spool-express)
- [sequelize](https://github.com/fabrix-app/spool-sequelize)

## Compatibility

- Windows, Mac, and Linux
- Node 8.0 and newer

## Documentation

See [**fabrix.app/doc**](http://fabrix.app/doc) for complete documentation.

## More Resources

#### Tutorials

#### Videos

#### Support
- [Live Gitter Chat](https://gitter.im/fabrix-app/fabrix)
- [Twitter](https://twitter.com/fabrix-app)
- [Fabrix.app Website](http://fabrix.app/support)
- [Stackoverflow](http://stackoverflow.com/questions/tagged/fabrix-app)

## FAQ

See https://github.com/fabrix-app/fabrix/wiki/FAQ

## Contributing
We love contributions! Please check out our [Contributor's Guide](https://github.com/fabrix-app/fabrix/blob/master/.github/CONTRIBUTING.md) for more
information on how our projects are organized and how to get started.

## License
[MIT](https://github.com/fabrix-app/fabrix/blob/master/LICENSE)

## Legacy
Fabrix would not have been possible without the substantial work done by the [Trail.js team](https://github.com/trailsjs). While Fabrix maintains a different code base and system of best practices, none of this would have been possible without the contributions from their community.

<img src="http://cdn.fabrix.app/art/backgrounds/fabrix-day.png">

[npm-image]: https://img.shields.io/npm/v/fabrix.svg?style=flat-square
[npm-url]: https://npmjs.org/package/fabrix
[ci-image]: https://img.shields.io/travis/fabrix-app/fabrix.svg?style=flat-square&label=Linux%20/%20OSX
[ci-url]: https://travis-ci.org/fabrix-app/fabrix
[appveyor-image]: https://img.shields.io/appveyor/ci/fabrix-app/fabrix/master.svg?style=flat-square&label=Windows
[appveyor-url]: https://ci.appveyor.com/project/fabrix-app/fabrix
[gitter-image]: http://img.shields.io/badge/+%20GITTER-JOIN%20CHAT%20%E2%86%92-1DCE73.svg?style=flat-square
[gitter-url]: https://gitter.im/fabrix-app/fabrix
[twitter-image]: https://img.shields.io/twitter/follow/fabrix-app.svg?style=social
[twitter-url]: https://twitter.com/fabrix-app
[coverage-image]: https://img.shields.io/codeclimate/coverage/github/fabrix-app/fabrix.svg?style=flat-square
[coverage-url]: https://codeclimate.com/github/fabrix-app/fabrix/coverage
27 changes: 27 additions & 0 deletions ROADMAP.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Tapestry

## Purpose

The fabrix.app team maintains this document to serve as a forward-looking plan for how the framework will grow and evolve. The goal of the roadmap is to assist developers in planning the future of their projects. Please submit an Issue or Pull Request if you feel that something should be added or changed in this document, and we are happy to discuss.

## Organization

Each major and minor release will be represented by a Github Milestone. Each major version series will be developed on a separate branch. Please submit feature requests, bug reports, and other suggestions as Github Issues for inclusion in a future release.

## Release Schedule

Fabrix intentionally parallels its release schedule with the [Node.js release schedule](https://github.com/nodejs/LTS#lts-plan).

![Fabrix Release and Maintenance Roadmap](https://s3.amazonaws.com/fabrix.app/images/Fabrix+Maintenance+Schedule+v4.5.png)

Major and minor version releases occur according to a regular calendar schedule, and versions are assigned according to semver. Major releases occur in April. The Fabrix team releases a minor version once per month with the latest feature updates for the current series. The fifth minor release, in October of the same year, will be tagged for LTS (Long Term Support) which lasts 18 months.

## Upcoming Releases

### v2.0 (April 2019)

Fabrix v2 development takes place on the [v2 branch](https://github.com/fabrix-app/fabrix/tree/v2). Some key changes and additions:
- Node 8 is required; ES5 code written for Node 4 will be refactored into ES6, however, this may be possible to compile to a lower version of Node.
- Separate i18n and logging from the core
- Introduce `Resolver` as a core Fabrix class
- Standardize `Policy` interface
Loading

0 comments on commit 2b40da5

Please sign in to comment.