/P2PCoder

Primary LanguageJavaScript

P2PCODER PLATFORM

A p2p code learning platform that connects developers to a single code editor over the internet. They can write and edit code, and communicate via audio and video streaming.

The goal of the project is to utilize Nextjs and technologies to build this project by newbies. The project has a mid-level degree of complexity, so would be broken down into difficulty levels throughout the 8 weeks.

This document is to help developers understand the platform and the development requirements of the project. The document will be updated from time to time to meet project expectations and standards.

DEVELOPMENT

During the development of the project, branches will be created for specific features/components/function development. PR will be created against this issue and will be merged to the development branch of the repository.

To find new issues please visit Projects or visit the Issue tab. A developer can request for clarification of an issue before going on so to ensure full compliance with development expectations and requirements.

FOLDERS AND NAMING STYLE

The folder structure is as follows

  • public
  • public/assets : For images used in the project
  • src/app For route pages
  • src/components for app components
  • src/composables for app functions

Folder naming would be responsibility of Team Lead. Augustine

FUNCTIONS AND EXPORT STYLE

The naming convention for components files would be [name]_comp.js eg. addButton_comp.js, highlightTree_comp.js

We'll be using the single file export system for our components and page exports

RUNNING SERVER

npm run dev
# or
yarn dev
# or
pnpm dev

Open http://localhost:3000 with your browser to see the result.

PR GUIDELINES

A branch can only be merged by owner Augustine. But can be approved by anyone.

TEAM