https://github.com/upstatement/open-source
Upstatement open source template
https://github.com/upstatement/open-source
Last synced: 8 months ago
JSON representation
Upstatement open source template
- Host: GitHub
- URL: https://github.com/upstatement/open-source
- Owner: Upstatement
- License: mit
- Created: 2019-02-05T16:28:00.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-07T14:35:10.000Z (about 3 years ago)
- Last Synced: 2025-01-18T17:48:32.963Z (about 1 year ago)
- Language: JavaScript
- Size: 152 KB
- Stars: 0
- Watchers: 15
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Open Source Template
> Concise description of project goes here
A more detailed description goes here. Why does this exist? How do we use it?
## Table of Contents
- [Open Source Template](#open-source-template)
- [Table of Contents](#table-of-contents)
- [What's in the Box](#whats-in-the-box)
- [System Requirements](#system-requirements)
- [Installation](#installation)
- [Getting Started](#getting-started)
- [Contributing](#contributing)
- [Code of Conduct](#code-of-conduct)
- [About Upstatement](#about-upstatement)
## What's in the Box
A list of things that this project provides
## System Requirements
List out anything that the user will need, such as:
- OS version
- Node version
- Any apps
- Administrator privileges (if `sudo` is needed)
## Installation
1. Clone this repository
```bash
git clone git@github.com:.git && cd
```
1. Install dependencies
```bash
npm install
```
## Getting Started
1. To start up the project run
```bash
npm start
```
1. Visit [insert URL here](/) to view your project
Also add something about development workflow if applicable
## Contributing
We welcome all contributions to our projects! Filing bugs, feature requests, code changes, docs changes, or anything else you'd like to contribute are all more than welcome! More information about contributing can be found in the [contributing guidelines](.github/CONTRIBUTING.md).
## Code of Conduct
Upstatement strives to provide a welcoming, inclusive environment for all users. To hold ourselves accountable to that mission, we have a strictly-enforced [code of conduct](CODE_OF_CONDUCT.md).
## About Upstatement
[Upstatement](https://www.upstatement.com/) is a digital transformation studio headquartered in Boston, MA that imagines and builds exceptional digital experiences. Make sure to check out our [services](https://www.upstatement.com/services/), [work](https://www.upstatement.com/work/), and [open positions](https://www.upstatement.com/jobs/)!