Skip to content

Commit

Permalink
Release 0.0.1 (Closes #8)
Browse files Browse the repository at this point in the history
* Copy all the seed files into the project folder

* Remove all useless AngularClass mentions

* Complete package.json info

* Change the app angular2 components selectors prefix

* Clean useless angular2 stuff from seed

* Try Travis build

* Remove app.service references

* Remove AppState deprecated references

* Update the netlify config file qith a basic config

* Remove base option

* Set the production build command as default

* Update humans.txt

* Fill manifest with the required metadata

* Remove useless assets

* Refactor manifest file

* Remove seed images and declarations

* Add logo images and set manifest colors

* Add favicon files

* Update head tags and move some assets

* Register a 144px icon at manifest.json

* Remove useless related plataforms field

* Use the Travis yarn cache

* Add a redirects file for allow history pushstate

* Update the manifest location at meta tag

* Install service workers API typescript types

* Install offline-webpack-plugin

* Prevent files with '_' prefix to be cached

* Install angularfire2

* Apply a base angular2 app files structure

* Init the firebase app and import into core module

* Create user service and class

* Include user service in core providers

* Use service worker at production

* Add User module and refactor app routing

* Import the user module into the app

* Update angularfire2 to avoid aot errors

* Install firebaseui package

* Linter fixes

* Remove @types/firebase package for types duplications

* Remove components empty style files

* Exclude the node modules and compiled files folders from the tree view

* Set markdown generic rules

* Add markdown and js linter files

* Add a superstatic file for redirect urls to index.html

* Eslint errors fixed

* Refactor lint scripts

* Clean seed README content

* Set Travis cache to 'bundler'

* Remove typedoc and add doctoc package and scripts

* Copy the README content from another project

* Update build badge and add netlify one

* Cache the node_modules directory at Travis CI

* Remove docs folder till it exits

* Add badge for commits since

* Add description and app logo

* Move the logo start centered

* Update the docs with the project details

* Lint the docs folder

* Update the package version

* Update README with the correct version

* Remove binnary scripts

* Add CONTRIBUTING file

* Create the CHANGELOG and give basic content

* Add version changes
  • Loading branch information
mdo2 authored Jan 12, 2017
1 parent 57fa711 commit eebd7df
Show file tree
Hide file tree
Showing 87 changed files with 3,448 additions and 18 deletions.
13 changes: 13 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
root = true

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

[*.md]
insert_final_newline = true
trim_trailing_whitespace = true
25 changes: 25 additions & 0 deletions .eslintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{
"env": {
"browser": true,
"commonjs": true,
"es6": true,
"node": true,
"jasmine": true,
"protractor": true
},
"parserOptions": {
"ecmaFeatures": {
"jsx": true
},
"sourceType": "module"
},
"rules": {
"no-const-assign": "error",
"no-this-before-super": "error",
"no-undef": "warn",
"no-unreachable": "error",
"no-unused-vars": "error",
"constructor-super": "warn",
"valid-typeof": "error"
}
}
1 change: 1 addition & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
yarn.lock -diff
60 changes: 46 additions & 14 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# Logs
logs
*.log
npm-debug.log*

# Runtime data
pids
Expand All @@ -14,24 +13,57 @@ lib-cov
# Coverage directory used by tools like istanbul
coverage

# nyc test 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 directories
node_modules
jspm_packages
# Users Environment Variables
.lock-wscript

# OS generated files #
.DS_Store
ehthumbs.db
Icon?
Thumbs.db

# Node Files #
/node_modules/
/bower_components/
npm-debug.log
/npm-debug.log.*

# Coverage #
/coverage/

# Typing #
/src/typings/tsd/
/typings/
/tsd_typings/

# Dist #
/dist
/public/__build__/
/src/*/__build__/
/__build__/**
/public/dist/
/src/*/dist/
/dist/**
/.awcache
.webpack.json
/compiled/

# Doc #
/doc/

# IDE #
.idea/
*.swp

# Optional npm cache directory
.npm

# Optional REPL history
.node_repl_history
# Angular #
*.ngfactory.ts
*.css.shim.ts
*.ngsummary.json
*.shim.ngstyle.ts
10 changes: 10 additions & 0 deletions .markdownlint.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"default": true,
"first-line-h1": false,
"no-inline-html": false,
"no-duplicate-header": false,
"blanks-around-headers": false,
"line-length": {
"line_length": 100
}
}
1 change: 1 addition & 0 deletions .nvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
lts/*
31 changes: 31 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
sudo: required
dist: trusty
addons:
apt:
sources:
- google-chrome
packages:
- google-chrome-stable
language: node_js
node_js:
- "4"
- "5"
- "6"
- "node"
cache:
directories:
- node_modules

# Matrix failure enabled for https://github.com/TheLarkInn/LazyParseWebpackPlugin/issues/6
matrix:
fast_finish: true
allow_failures:
- node_js: "4"
install:
- npm install
before_script:
- export DISPLAY=:99.0
- sh -e /etc/init.d/xvfb start
- sleep 3
script:
- npm run ci
27 changes: 27 additions & 0 deletions .vscode/launch.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
{
"version": "0.2.0",
"configurations": [
{
"name": "Launch Chrome against localhost, with sourcemaps",
"type": "chrome",
"request": "launch",
"url": "http://localhost:3000/*",
"runtimeArgs": [
"--disable-web-security",
"--user-data-dir",
"--remote-debugging-port=9222"
],
"sourceMaps": true,
"webRoot": "${workspaceRoot}"
},
{
"name": "Attach to Chrome, with sourcemaps",
"type": "chrome",
"request": "attach",
"url": "http://localhost:3000/*",
"port": 9222,
"sourceMaps": true,
"webRoot": "${workspaceRoot}"
}
]
}
8 changes: 8 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"typescript.tsdk": "node_modules/typescript/lib/",
"files.exclude": {
".git*": true,
"**/node_modules/**": true,
"compiled": true
}
}
29 changes: 29 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Change Log
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](http://keepachangelog.com/)
and this project adheres to [Semantic Versioning](http://semver.org/).

## [Unreleased]

## [0.0.1] - 2017-01-12
### Added

- [angular2-webpack-starter](https://github.com/AngularClass/angular2-webpack-starter) seed used
to start the project
- [Travis CI](https://travis-ci.org) as CI environment for testing
- [Netlify](https://www.netlify.com) integration to have CD [here](https://poll-me.com).
- Fill the [Progressive Web App](https://developer.mozilla.org/en-US/Apps/Progressive) standard
- App logos
- Basic angular2 structure
- Initial documentation
- Lint of javascript and markdown files
- [Firebase](https://firebase.google.com/) integration for user authentication and data storage

## 0.0.0 - 2017-01-09
### Added

- All, repository init

[Unreleased]: https://gitlabnew.qdqmedia.com/shared-projects/eqonecta/compare/HEAD...develop
[0.0.1]: https://gitlabnew.qdqmedia.com/shared-projects/eqonecta/compare/v0.0.0...v0.0.1
4 changes: 4 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Contributing to this project
All you need to know about how to contribute is at
[development flow documentation](docs/dev-flow.md) that explain the way to work at the
project.
5 changes: 3 additions & 2 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License
The MIT License (MIT)

Copyright (c) 2016 Poll-me
Copyright (c) 2015-2016 PollMe

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 All @@ -19,3 +19,4 @@ 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.

109 changes: 107 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,107 @@
# poll-me-webapp
The Poll-me webapp
<p align="center">
<a href="https://www.poll-me.com" target="_blank">
<img width="192" alt="PollMe WebApp" src="src/assets/img/favicon/android-chrome-192x192.png">
</a>
</p>

# PollMe Web Application

[![GitHub version](https://badge.fury.io/gh/Poll-me%2Fpoll-me-webapp.svg)](https://badge.fury.io/gh/Poll-me%2Fpoll-me-webapp)
[![GitHub release](https://img.shields.io/github/release/Poll-me/poll-me-webapp.svg)](https://github.com/Poll-me/poll-me-webapp/releases)
[![Build Status](https://travis-ci.org/Poll-me/poll-me-webapp.svg)](https://travis-ci.org/Poll-me/poll-me-webapp)
[![GitHub commits](https://img.shields.io/github/commits-since/Poll-me/poll-me-webapp/0.0.1.svg)](https://github.com/Poll-me/poll-me-webapp/compare/v0.0.1...develop)
[![Build Status](https://www.netlify.com/img/global/badges/netlify-color-accent.svg)](https://www.netlify.com)

This is the awesome app with with you be able to collect in the most easy way any kind of
opinion or preferece from anyone.

For example:

- Are you trying to know the best date to a plan with you friends? **POLL THEM!!**
- Are you trying to decide which Star Wars movie is better? **POLL THEM!!**
- Are you trying to find out which friend of yours knows you better? **POLL THEM!!**

[Enter now](https://www.poll-me.com) and try it out, it's **free FOREVER**

The project follow this development technology stack:

1. Angular2
1. Webpack
1. Node

And the build outputs all the static files that can be easily served from a web server.

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)*

- [Requirements](#requirements)
- [Start working with the project](#start-working-with-the-project)
- [Development flow](#development-flow)
- [Package scripts](#package-scripts)
- [Enviroments](#enviroments)
- [Architecture](#architecture)
- [Continuous integration (CI)](#continuous-integration-ci)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

## Requirements
The only thing you need is:

- Node >= 4.x
- Npm >= 3.x

## Start working with the project
To contribute you just need to clone the repo and install the node dependencies, then you
can run any package script.

```bash
# Clone the repo and enter inside
git clone git@github.com:Poll-me/poll-me-webapp.git
# by HTTPS: https://github.com/Poll-me/poll-me-webapp.git
cd poll-me-webapp

# install node dependencies
npm install

# Start the dev server with a watcher running
npm start
```

## Development flow
You must follow [this](docs/dev-flow.md) guidelines in order to contribute to the project in any way.

## Package scripts
As the project do not have a task builder like Grunt or Gulp we need to use the npm package scripts
to run the tasks that manage the workflow of the project.

All of this scripts are listed [here](docs/scripts.md)

## Enviroments
This project contemplate many possible environments that are used at different parts
of the source code, for example, at webpack configuration.

- **Development** (`dev`): the environment for develop the project.
For example at developers computers.
- **Test** (`test`): the environment for the tests execution.
- **Continuous Integration** (`ci`): the environment executed by the CI runner.
- **Production** (`prod`): the environment for serve the production app files.
For example at deploy environments.

## Architecture
The app have a structure that ensure readability, maintainability and scalability.

When you want to collaborate on the project you **MUST** consider this architecture as
guideline in order to add new functionality.

Details are exposed at specific docs [here](docs/architecture.md)

## Continuous integration (CI)
The central pillar of development flow, all the commits pushed to the remote github
repository have to pass the pipeline of the project at CI to can merge to `develop`
branch and then to `master`.

The CI of the project is based on [Travis CI](https://travis-ci.org/), you can see the official documentation
[here](https://docs.travis-ci.com/). The configturation of the project that set how
the project is checked at CI is `.travis.yml`, if you want to know more about the CI
configuration for the project see the [official docs](https://docs.travis-ci.com/user/customizing-the-build/).
8 changes: 8 additions & 0 deletions config/empty.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
module.exports = {
NgProbeToken: {},
HmrState: function() {},
_createConditionalRootRenderer: function(rootRenderer) {
return rootRenderer;
},
__platform_browser_private__: {}
};
Loading

0 comments on commit eebd7df

Please sign in to comment.