Project Name: Streamic

Table of Contents

• Description

• To Learn more to code

• Installation

  • Prerequisite
  • Clone the Repo
  • Install all the packages
  • To run the web
  • Go to the website

• Usage

• Contributing

• Credits

• License

Description

This a webpage that allows the user to stream together with friends and to communicte with them through the web app

To Learn more to code

To learn more about Next.js, take a look at the following resources:

• Next.js Documentation - learn about Next.js features and API.
• Learn Next.js - an interactive Next.js tutorial.
• Socket - Socket.io for messaging and player
• Semantic UI React - The design componets used

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Installation

Prerequisite

You need npm installed

npm install npm@latest -g

Clone the Repo

git clone https://github.com/AppDevIn/P2.git

Install all the packages

npm install
npm ci

To run the web

npm run dev

Go to the website

http://localhost:3000/

Usage

Contributing

All contributors, please follow this guide it is greatly appreciated. Please don't push to the master branch without being reviewed by one of your team memebers.

1. Check the Trello board
2. Choose a story to work on that sprint
3. Move it to the PRODUCT BACKLOG and Tag your name
4. Create your Feature Branch (git checkout -b feature-{feature-name}-{version}) from the develop
5. Commit your Changes (git commit -m 'Add some AmazingFeature')
6. Merge to develop branch
7. After each sprint, make a pull request to the master branch

Credits

Jeyavishnu

Hou Man

Zachary

woei yih

Sandra Choy

License

Distributed under the MIT License. See LICENSE for more information.