sdupertuys / byor-voting-web-app

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

BYOR-VotingApp [web-app]

CircleCI Commitizen friendly semantic-release

Welcome to the main repository for the BYOR-VotingApp!

This repository contains the source code of the web-app, if you are looking for information about the server component please access BYOR-VotingApp [server] repository. If you want to explore all the setup and deployment options, take a look at BYOR-VotingApp [infrastructure] one.

Table Of Contents

BUILD YOUR OWN RADAR (aka BYOR)

BYOR-VotingApp

Documentation

How to contribute to the project

BUILD YOUR OWN RADAR (aka BYOR)

ThoughtWorks build its own Technology Radar twice a year.

you can find the latest edition here.

We found it so useful that we decided to share the process and build some tools to help every organization run their own radar creation exercise.

you can find more information about the process and how the tech radar works here.

Building your own tech radar, invites you to have a conversation across all organizational levels and review your entire technology portfolio.

This enables you to:

  • Objectively assess what's working, and what isn't
  • Pollinate innovation across teams and experiment accordingly
  • Balance the risk in your technology portfolio
  • Work out what kind of technology organization you want to be
  • Set a path for future success

ThoughtWorks encourage you to run the radar twice a year to keep your organisation aware of the fast changing technologies landscape.

BYOR-VotingApp

Main features

The BYOR-VotingApp comes preloaded with around 943 technologies to choose among and 1.860 blips evaluated by ThoughtWorks to compare with, extracted from TW TechRadar Vol1 up to Vol20.

If you are planning to use the BYOR creation excercise, the BYOR-VotingApp can help you to:

All the Data is stored in a MongoDB database.

Running BYOR-VotingApp locally

  1. install Docker
  2. open the terminal
  3. clone the project
    git clone https://github.com/thoughtworks/byor-voting-web-app.git
  4. move into the project folder
    cd byor-voting-web-app
  5. startup web app, server, and a local MongoDB
    docker-compose -f docker-compose.all.yml up
  6. access the application front-end on http://localhost:4201

if needed, application back-end is accessible on http://localhost:3001 and application's mongo database is accessible at localhost:27019

Please refer to CONTRIBUTING.md for more options on running the web app locally.

Please refer to BYOR-VotingApp [server] Github repository for more options on running the server locally and connect to a MongoDB database.

Running BYOR-VotingApp on Kubernetes or AWS S3

Please refer to BYOR-VotingApp [infrastructure] Github repository for installing the application on Kubernetes or AWS S3.

Documentation

In the docs folder you can find:

  • a deck to share or present for explaining what the Tech Radar is and how to rate technologies.
  • the user guide
  • the admin guide

How to contribute to the project

Please refer to CONTRIBUTING.md for all the information about how to contribute.

About

License:GNU Affero General Public License v3.0


Languages

Language:TypeScript 85.2%Language:HTML 6.0%Language:SCSS 4.1%Language:Shell 3.3%Language:JavaScript 0.6%Language:Makefile 0.5%Language:Dockerfile 0.3%