Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
github-classroom[bot] authored Feb 20, 2024
0 parents commit 6582124
Show file tree
Hide file tree
Showing 31 changed files with 1,631 additions and 0 deletions.
49 changes: 49 additions & 0 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Use the latest 2.1 version of CircleCI pipeline process engine.
# See: https://circleci.com/docs/2.0/configuration-reference
version: 2.1

# Define the jobs we want to run for this project
jobs:
build-and-test-express-js:
docker:
- image: cimg/node:16.13.0 # latest stable node at the time of writing
# auth:
# username: mydockerhub-user
# password: $DOCKERHUB_PASSWORD # context / project UI env-var reference
steps:
- checkout
- run: echo "this is the build and test express.js job"
- run: |
cd back-end
pwd # for debugging: show current working directory
ls # for debugging: show sub-directories in here
- run: |
cd back-end
npm install # install all dependencies listed in package.json
npm test # run all unit tests
build-react-js:
docker:
- image: cimg/node:16.13.0 # latest stable node at the time of writing
# auth:
# username: mydockerhub-user
# password: $DOCKERHUB_PASSWORD # context / project UI env-var reference
steps:
- checkout
- run: echo "this is the build react.js job"
- run: |
cd back-end
pwd # for debugging: show current working directory
ls # for debugging: show sub-directories in here
- run: |
cd front-end
npm install # install all dependencies listed in package.json
npm run build # have react build the stand-alone front-end code
# Orchestrate our job run sequence
workflows:
build-and-test-back-end:
jobs:
- build-and-test-express-js
build-front-end:
jobs:
- build-react-js
2 changes: 2 additions & 0 deletions .circleci/note.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
The file in this directory named config.yml contains configuration settings for Circle-CI (https://circleci.com).
There is no need to touch files in this directory.
9 changes: 9 additions & 0 deletions .github/ISSUE_TEMPLATE/spike-template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
name: Spike Template
about: A template to use for Spikes
title: ""
labels: spike
assignees: ""
---

_By definition, this `spike` is not related to any specific User Story._
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/task-template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
name: Task Template
about: A template to use for Tasks
title: ""
labels: task
assignees: ""
---

Related to User Story #?

_By definition, this `task` represents one unit of work that is part of the implementation of a single user story._
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/user-story-template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
name: User Story Template
about: A template to use for User Stories
title: ""
labels: user story
assignees: ""
---

## Estimation of effort (optional)

- TBD

## Acceptance criteria (optional)

- [ ] foo
- [ ] bar
- [ ] baz
- [ ] etc
2 changes: 2 additions & 0 deletions .github/note.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
The files in this directory contain configuration settings for GitHub Actions (https://docs.github.com/en/actions).
Do not modify the given files, although you are welcome to add additional files as needed.
56 changes: 56 additions & 0 deletions .github/workflows/event-logger.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
name: log github events
on:
push:
branches: [main, master]
pull_request:
types: [opened, closed]
branches: [main, master]
jobs:
log:
runs-on: ubuntu-latest
env:
COMMIT_LOG_API: ${{ secrets.COMMIT_LOG_API }}
GITHUB_LOGIN: ${{ github.actor }} # github login also available in github.triggering_actor, github.event.sender.login
COMMITS: ${{ toJSON(github.event.commits) }}
REPOSITORY_URL: ${{ github.repositoryUrl }}
EVENT_TYPE: ${{ github.event_name }}
EVENT_ACTION: ${{ github.event.action }}
PR_MERGED: ${{ github.event.pull_request.merged }}
PR_CREATED_AT: ${{ github.event.pull_request.created_at}}
PR_CLOSED_AT: ${{ github.event.pull_request.closed_at}}
steps:
- uses: actions/checkout@v3
with:
fetch-depth: 0 # this is important so git fetches all history.. the actions/checkout by default fetches all history as one commit which throws off stats
- uses: actions/setup-python@v3
with:
python-version: "^3.9"
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install --user pipenv
pipenv install pytz
pipenv install python-dateutil
pipenv install build
pipenv install requests
pipenv install gitcommitlogger
- name: Log pull request opened
if: github.event_name == 'pull_request' && github.event.action == 'opened'
run: |
pipenv run gitcommitlogger -r $(echo $REPOSITORY_URL) -t pull_request_opened -d $(echo $PR_CREATED_AT) -un $(echo $GITHUB_LOGIN) -o commit_stats.csv -u $(echo $COMMIT_LOG_API) -v
- name: Log pull request closed and merged
if: github.event_name == 'pull_request' && github.event.action == 'closed' && github.event.pull_request.merged == true
run: |
echo $COMMITS > commits.json
cat commits.json # debugging
pipenv run gitcommitlogger -r $(echo $REPOSITORY_URL) -t pull_request_merged -d $(echo $PR_CLOSED_AT) -un $(echo $GITHUB_LOGIN) -i commits.json -o commit_stats.csv -u $(echo $COMMIT_LOG_API) -v
- name: Log pull request closed without merge
if: github.event_name == 'pull_request' && github.event.action == 'closed' && github.event.pull_request.merged == false
run: |
pipenv run gitcommitlogger -r $(echo $REPOSITORY_URL) -t pull_request_closed -d $(echo $PR_CLOSED_AT) -un $(echo $GITHUB_LOGIN) -o commit_stats.csv -u $(echo $COMMIT_LOG_API) -v
- name: Log push
if: github.event_name == 'push'
run: |
echo $COMMITS > commits.json
cat commits.json # debugging
pipenv run gitcommitlogger -r $(echo $REPOSITORY_URL) -t $(echo $EVENT_TYPE) -i commits.json -o commit_stats.csv -u $(echo $COMMIT_LOG_API) -v
129 changes: 129 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,129 @@
# Compiled source #
###################
*.com
*.class
*.dll
*.exe
*.o
*.so

# Packages #
############
# it's better to unpack these files and commit the raw source
# git has its own built in compression methods
*.7z
*.dmg
*.gz
*.iso
*.jar
*.rar
*.tar
*.zip

# Logs and databases #
######################
*.log
*.sql
*.sqlite

# OS generated files #
######################
.DS_Store
.DS_Store?
._*
.Spotlight-V100
.Trashes
ehthumbs.db
Thumbs.db

# Typical Node.js artifacts #
#############################

# Lock file so we don't bloat the git log stats
package-lock.json

# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Directory for instrumented libs generated by jscoverage/JSCover
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

# Bower dependency directory (https://bower.io/)
bower_components

# node-waf configuration
.lock-wscript

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

# Dependency directories
node_modules/
**/node_modules/
jspm_packages/
**/jspm_packages

# Results of React build script
build/
**/build/

# React dependencies
.pnp
.pnp.js

# dotconfig artifacts
.env.local
.env.development.local
.env.test.local
.env.production.local

# TypeScript v1 declaration files
typings/

# Optional npm cache directory
.npm

# Optional eslint cache
.eslintcache

# Optional REPL history
.node_repl_history

# Output of 'npm pack'
*.tgz

# Yarn Integrity file
.yarn-integrity

# dotenv environment variables file
.env

# next.js build output
.next


## Emacs artefacts ##
*~

## Jekyll artifacts
**/.jekyll-cache
**/_site/
2 changes: 2 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Guide to Contributing
Delete the contents of this file and replace with the contents of a proper guide to contributing to this project, as described in the [instructions](./instructions.md)
Loading

0 comments on commit 6582124

Please sign in to comment.