Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mjamesd/go-team-go

Software development team & member profile generator
https://github.com/mjamesd/go-team-go

Last synced: 8 days ago
JSON representation

Software development team & member profile generator

Awesome Lists containing this project

README

        

# Go, Team, Go!

> _Software development team & member profile generator_

![status: in development](https://img.shields.io/badge/status-in%20development-orange)

![License: GNU General Publice License v3.0](https://img.shields.io/badge/license-GNU%20General%20Publice%20License%20v3.0-yellowgreen)

## Description

I built a Node.js command-line application that takes in information about employees on a software engineering team, then generates an HTML webpage that displays summaries for each person. Testing is key to making code maintainable, so I also wrote a unit test for every part of my code and ensured that it passes each test.

## User Story

```
AS A manager
I WANT to generate a webpage that displays my team's basic info
SO THAT I have quick access to their emails and GitHub profiles
```

## Table of Contents

1. [Description](#description)
2. [Installation](#installation)
3. [Usage](#usage)
4. [Tests](#tests)
5. [License](#license)
6. [Questions](#questions)

## Installation

1. Clone the repository.

2. Run `npm i` to install dependencies.

3. Run `node server.js` to begin the program.

## Usage

[View this video for usage](https://drive.google.com/file/d/1il4zQTjIIQbk8wx4y1AjlGuuLBBMO7iD/view).

## Tests

In the main directory, run `npm run test`.

## License

This work is licensed under GNU General Publice License v3.0.

## Questions

Visit [my GitHub profile](https://github.com/mjamesd)

To reach me with additional questions, send me an [email](mailto:[email protected]).