From 8865da2e23113f1581bf2d0e71df3c15dc649ac4 Mon Sep 17 00:00:00 2001 From: Reuven Yagel Date: Fri, 3 Mar 2017 09:26:13 +0200 Subject: [PATCH] 207b version --- .github/ISSUE_TEMPLATE.md | 42 +++++++++++++++++++++ .gitignore | 78 +++++++++++++++++++++++++++++++++++++++ .travis.yml | 4 ++ LICENSE | 21 +++++++++++ README.md | 58 +++++++++++++++++++++++++++++ package.json | 19 ++++++++++ 6 files changed, 222 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .gitignore create mode 100644 .travis.yml create mode 100644 LICENSE create mode 100644 README.md create mode 100644 package.json diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 000000000..3a00fd3fb --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,42 @@ +Todo: delete all unnecessary items, add suitable labels (with priotity and estimation), milestone, assignee, etc. +## Feature Template + +#### Related Issues/Tasks +- [ ] #1 +- [ ] #2 + +#### Scenario (test) +- [ ] Step 1 +- [ ] ... +- [ ] Expected result + +## User Story Template +- As a ... +- I want ... +- So that ... + +## Bug Template +#### Expected behavior +#### Actual behavior +#### Steps to reproduce the behavior + +## Project Submission Template +#### Iteration page: [here](../wiki/iter-6.md) +#### Checklist, e.g.,: +- [ ] Feature scenarios/tests passing +- [ ] Iteration page updated, including: + - [ ] Iteration retrospective + - [ ] Code reviewes + - [ ] Client review + - [ ] Issues updates + - [ ] Section on application of course materials +- [ ] git tag +- [ ] Next iteration: + - [ ] Open page + - [ ] Select stories and plan issues + - [ ] Test scenarios +- [ ] All engineers filled peer-review +- [ ] Submitted + - [ ] Announcement in chat room + - [ ] Assign this issue to checker + - [ ] Register for a review meeting diff --git a/.gitignore b/.gitignore new file mode 100644 index 000000000..c94f3514c --- /dev/null +++ b/.gitignore @@ -0,0 +1,78 @@ +# https://git-scm.com/docs/gitignore +# https://help.github.com/articles/ignoring-files +# Example .gitignore files: https://github.com/github/gitignore + +# -------------------- +# OSX Files +# -------------------- +.DS_Store +.AppleDouble +.LSOverride +Icon +._* +.Spotlight-V100 +.Trashes + +# -------------------- +# Eclipse or Nodeclipse "Enide Studio" Files +# -------------------- +# recommended to add to Git SCM +# or generate with `nodeclipse -p` command +.project +.settings/ +.*.md.html + + +# -------------------- +# IntelliJ Files +# -------------------- +*.iml +*.ipr +*.iws +.idea/ + +# -------------------- +# Netbeans Files +# -------------------- +nbproject/private/ +build/ +nbbuild/ +dist/ +nbdist/ +nbactions.xml +nb-configuration.xml + +# -------------------- +# Node Files +# -------------------- +.nodemonignore +npm-debug.log +node_modules/ + +# -------------------- +# SASS Files +# -------------------- +.sass-cache/ + +# -------------------- +# Bower Files +# -------------------- +.bower-*/ +bower_components + +# -------------------- +# App Files +# -------------------- +data/ +tests/results/** +modules/public/ +modules/views/ +/public/build/ +/packages/contrib/ +/packages/**/**/public/assets/lib + + +# -------------------- +# vim Files +# -------------------- +*.swp diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 000000000..1cda1edee --- /dev/null +++ b/.travis.yml @@ -0,0 +1,4 @@ +language: ruby +rvm: 2.2 +before_script: gem install awesome_bot +script: awesome_bot README.md docs/*.md --white-list travis-ci diff --git a/LICENSE b/LICENSE new file mode 100644 index 000000000..853b46db1 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2016 + +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. diff --git a/README.md b/README.md new file mode 100644 index 000000000..d36590484 --- /dev/null +++ b/README.md @@ -0,0 +1,58 @@ +# project-template + +A template repository with wiki for a team project at JCE's software engineering course (replace with the mission of your project). + +(See also:rRecommended [checklist](https://github.com/ddbeck/readme-checklist/blob/master/checklist.md) for a README) + +![project logo (this one for is taken from basecamp - a project management service)](https://www.klipfolio.com/sites/default/files/integrations/basecamp.png) + +## Tools & Practices +We're trying to use the best tools and practices in order to produce a quality enginneered product. +(replace 'jce-il/project-template' with your 'username/repo' and register to the relevant services) + +|Category|Status| +|---|---| +| Version Control System| git & github | +| Recommended IDE | [VSCode](https://code.visualstudio.com) | +| Group Chat | [![Join the chat at https://gitter.im/jce-il/project-template](https://badges.gitter.im/jce-il/project-template.svg)](https://gitter.im/jce-il/project-template?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) | +| Build Status (CI) | [![Build Status](https://travis-ci.org/jce-il/project-template.svg?branch=master)](https://travis-ci.org/jce-il/project-template) | +| Dependencies | [![David](https://img.shields.io/david/dev/idleberg/vscode-badges.svg?style=flat-square)](https://david-dm.org/jce-il/project-template?type=dev) | +| License | [![Open Source Love](https://badges.frapsoft.com/os/mit/mit.svg?v=102)](https://github.com/ellerbrock/open-source-badge/) | +| Test Coverege | [![codecov.io](https://codecov.io/github/jce-il/project-template/coverage.svg?branch=master)](https://codecov.io/github/jce-il/project-template?branch=master) | +| Code Quality | [![Code Climate](https://codeclimate.com/github/jce-il/project-template.svg)](https://codeclimate.com/github/jce-il/project-template) | +| Code Style | [![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/jce-il/project-template) | +| Current Release | [![Current Version](https://img.shields.io/github/release/jce-il/project-template.svg?style=flat)](https://github.com/jce-il/project-template/releases) | +| Github Issues | [![GitHub issues](https://img.shields.io/github/issues/jce-il/project-template.svg?style=flat)](https://github.com/jce-il/project-template/issues) | +| Project Management Board| [here](https://github.com/jce-il/project-template/projects/1) | +| Deployment | [![Heroku](http://heroku-badge.herokuapp.com/?app=my-app&style=flat&svg=1&root=index.html)] | +| Security | [![Known Vulnerabilities](https://snyk.io/test/github/jce-il/project-template/badge.svg)](https://snyk.io/test/github/jce-il/project-template) | +| Project Course Status | ... | + +## Please visit our [live application](https://demo.reactstarterkit.com/) +- Alright, currently only a landing page... + + +## Disclaimer +This project is developed as part of the requirements for a [software engineering course](https://github.com/jce-il/se-class/wiki) at the software engineering department - [Azrieli College of Engineering](http://www.jce.ac.il/), Jerusalem, Israel. + +Please visit our wiki for furthur project info: + +### [User Manual](../../wiki/user-manual) (empty for now) + +### [Team Page](../../wiki/team) + +### Project Documents +- [Project Idea](docs/idea.pdf) ([Presentation](docs/idea-slides.pdf)) +- [Project Inception](../../wiki/inception) +- [Software Requirements Specification](../../wiki/srs) +- [Software Design Specification](../../wiki/sds) + +### Iteration Pages +- [Iteration 0 - ZFR](../../wiki/iter0-zfr) +- [Iteration 1 - MVP]() +- [Iteration 2 - Feature X]() +- [Iteration 3 - Feature Y]() +- [Iteration 4 - Feature Z]() + + + diff --git a/package.json b/package.json new file mode 100644 index 000000000..7150eb251 --- /dev/null +++ b/package.json @@ -0,0 +1,19 @@ +{ + "name": "project-template", + "version": "1.0.0", + "description": "A template repository with wiki for a team project at JCE's software engineering course", + "main": "index.js", + "scripts": { + "test": "echo \"Error: no test specified\" && exit 1" + }, + "repository": { + "type": "git", + "url": "git+https://robi-y@github.com/jce-il/project-template.git" + }, + "author": "robi-y", + "license": "MIT", + "bugs": { + "url": "https://github.com/jce-il/project-template/issues" + }, + "homepage": "https://github.com/jce-il/project-template#readme" +}