Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions .eslintrc.json
Original file line number Diff line number Diff line change
@@ -1,17 +1,18 @@
{
"env": {
"browser": true,
"node": true,
"es2021": true
},
"extends": [
"eslint:recommended",
"prettier"
],
"extends": ["eslint:recommended", "prettier"],
"parserOptions": {
"ecmaVersion": 12,
"sourceType": "module"
},
"rules": {
"no-console": "warn"
"no-console": "off"
},
"globals": {
"clients": "readonly"
}
}
28 changes: 13 additions & 15 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

# Contributor Covenant Code of Conduct

## Our Pledge
Expand All @@ -18,23 +17,23 @@ diverse, inclusive, and healthy community.
Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
- Focusing on what is best not just for us as individuals, but for the
overall community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or
- The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
- Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities
Expand Down Expand Up @@ -107,7 +106,7 @@ Violating these terms may lead to a permanent ban.
### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within
Expand All @@ -119,16 +118,15 @@ This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].

Community Impact Guidelines were inspired by
Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].

For answers to common questions about this code of conduct, see the FAQ at
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available
at [https://www.contributor-covenant.org/translations][translations].

[homepage]: https://www.contributor-covenant.org
[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
[Mozilla CoC]: https://github.com/mozilla/diversity
[FAQ]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations

70 changes: 35 additions & 35 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
This project welcomes contributors to help improve its codebase by identifying shortcomings
in the project, highlighting bugs, and issues in the documentation.

This is not a 'for hire' project. It's open source, so contribution to this project
is based on developer community improvements. This streaming platform was created specifically
This is not a 'for hire' project. It's open source, so contribution to this project
is based on developer community improvements. This streaming platform was created specifically
by community developers for developers, hobbyists alike.

This is a PWA.
Expand All @@ -15,25 +15,25 @@ Anyone with basic programming skills down contribute immensely to this project.

Areas requiring contribution includes:

- **Error checks**: Identify any mispellings or errors in documentation
- **Error checks**: Identify any mispellings or errors in documentation

- **Documentation**: Possess good documentation skills: Good spelling, punctuation, knowledge of Markdown and grammar checker tool, and you believe you can help elevate this projects' documentation even better?
- **Documentation**: Possess good documentation skills: Good spelling, punctuation, knowledge of Markdown and grammar checker tool, and you believe you can help elevate this projects' documentation even better?

- **Code contribution**: Identify a bug in this app or thought of a new feature that could plunge this app to a new dimension.
- **Code contribution**: Identify a bug in this app or thought of a new feature that could plunge this app to a new dimension.

- **Tests**: Contribute CI, CD, Docker, Unit tests, E2E tests, Integration tests to
help us ensure PRs don't introduce breaking changes, etc.
- **Tests**: Contribute CI, CD, Docker, Unit tests, E2E tests, Integration tests to
help us ensure PRs don't introduce breaking changes, etc.

- **Browser Testing**: Ideally this should work with no or minimal browser console errors, warnings, alerts.
If you encounter any specific warnings, errors, alerts.
Ideally this should work across mobile, desktop and many different devices Windows, Mac, Linux and different processor architectures as
well as different browsers.
- **Browser Testing**: Ideally this should work with no or minimal browser console errors, warnings, alerts.
If you encounter any specific warnings, errors, alerts.
Ideally this should work across mobile, desktop and many different devices Windows, Mac, Linux and different processor architectures as
well as different browsers.

Please review your browser's console during development.

'console.log' everything necessary to ensure everything is working.

Add error messages where necessary
Add error messages where necessary

## How to contribute

Expand All @@ -43,7 +43,7 @@ These next subheadings will get you started on making your contributions to this

If you are not sure what to work on, review the issues list first. There are also TODO's listed in the included [TODO.md](./TODO.md) file.

Please '//TODO' mark incomplete areas and add them to the TODO.md file.
Please '//TODO' mark incomplete areas and add them to the TODO.md file.

@gbowne1 and other project maintainers will assign users to issues on a first come, first serve basis. If you would like to work on an issue, feel free to indicate by tagging the mentioned persons.

Expand All @@ -60,9 +60,9 @@ If none has been created, Click on the green [New Issue] button.

Describe your issue as well as you can:

- Include code snippits where the issue lies.
- Include screenshots (optional).
- Include a short video (optional).
- Include code snippits where the issue lies.
- Include screenshots (optional).
- Include a short video (optional).

If the issue appears to be a browser, operating system, device specific issue, let us know what those are.

Expand All @@ -78,11 +78,11 @@ tool and editor/IDE agnostic so you can use whatever editor or IDE or you like.

The [DEVSETUP](/docs/DEVSETUP.md) file contains instructions for developers on how to:

- Clone or Fork the project,
- Set up the project in their IDE or editor,
- Set up their environment to work in the project, including any environment variables, yarn/npm/pnpm package(s), editor extensions or plugins needed,
- Setting up the connection to the database,
- Setting up the local development database, MongoDB.
- Clone or Fork the project,
- Set up the project in their IDE or editor,
- Set up their environment to work in the project, including any environment variables, yarn/npm/pnpm package(s), editor extensions or plugins needed,
- Setting up the connection to the database,
- Setting up the local development database, MongoDB.

## Prerequisites to use Database for programmers

Expand All @@ -92,7 +92,7 @@ Also, use accessibility (A11y) with themes and styles paying attention to
focus styling, contrast and keyboard accesibility.

Lastly, the browser gives us things like localStorage, IndexedDB, Session Storage,
Cookies and Cache Storage. Make secure usage of all of these
Cookies and Cache Storage. Make secure usage of all of these

## Pull Request

Expand All @@ -104,14 +104,14 @@ Assignees, Reviewers, Labels, Projects, Milestone(s) and Development before you
Also, write a brief description of what you fixed. Keep in mind that Blank issues and PR's
without a description of the changes you made may not get merged.

- Link an issue to Development that the PR will close
- Make sure that you tag a reviewer i.e. @gbowne1
- Pick appropriate labels from Labels
- Make sure you are the assignee to the PR.
- Milestone, choose Frontend or Backend (more may come later on)
- Link an issue to Development that the PR will close
- Make sure that you tag a reviewer i.e. @gbowne1
- Pick appropriate labels from Labels
- Make sure you are the assignee to the PR.
- Milestone, choose Frontend or Backend (more may come later on)

Please provide a short video, copy of log(s), passing tests,
screenshots of working changes. This helps with reviewers knowing
screenshots of working changes. This helps with reviewers knowing
what to expect with your changes and contributions.

If you manage to contribute a minimum of 3 accepted and merged PRs, you can request to be a contributor/maintainer/collsborator.
Expand All @@ -137,19 +137,19 @@ working with our code base.

## Tech Stack

This project was bootstrapped with these libraries, modules, packages
This project was bootstrapped with these libraries, modules, packages

All core components, modules, etc. are built with JavaScript.

## Branches

Our branches follow GitFlow / GitHub Flow as a general rule.

- [ main ] main working branch
- [ master ] Permanent // Archive branch
- [ test ] untested code
- Feature Branch # of feature - {feature}
- [bugfix - { fixed bug }]
- [hotfix - { fix }]
- [ main ] main working branch
- [ master ] Permanent // Archive branch
- [ test ] untested code
- Feature Branch # of feature - {feature}
- [bugfix - { fixed bug }]
- [hotfix - { fix }]

Use a test branch to commit/push code that you believe should work but is not completely tested.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# 📺 CodeStream (Prototype)

This is the code for a live streaming platform for programmers currently called DevStream but naming things is hard so this name is a placeholder.

CodeStream (initially named **DevStream**) is a **Full-Stack Web Application** designed as a **live streaming platform specifically for developers**.

This project currently represents a **functional Proof of Concept (PoC)** featuring a complete **Authentication system**, a **modern responsive UI with Dark Mode**, and a **mock streaming API**.
Expand Down
Loading
Loading