Skip to content

Latest commit

 

History

History
59 lines (48 loc) · 1.66 KB

README.md

File metadata and controls

59 lines (48 loc) · 1.66 KB

MyPal-dev

👾👾👾 Dev environment of MyPal
alt text Covid hit the entire experience of college life badly. Making new friends, doing gossips, attending meetups was the best part of college life.

MyPal was created to take the entire experience of your college life online.

List of features:
1.Share your thoughts with your community on the feed
2.Confess anonymously
3.Attend virtual events
4.Seamlessly chat with new Pals

Stack:

Stack Technology
Frontend React.js
State management React Context API
Component Library material-ui
Backend Firebase cloud functions
Database Firebase Realtime, Firestore

Others: WebRTC

Directory Structure:

Directory Contents
client has all the ui-components along with calls to firebase for fetching data
server has firebase functions to react to changes in firestore/firebase-realtime databases

Make a local copy

git clone https://github.com/X-TRON404/MyPal-dev.git

Run locally:

cd client
npm install
npm start

Contribution guidelines:

commit messages:
feat: The new feature you are adding to MyPal
fix: A bug fix
style: Feature and updates related to styling
refactor: Refactoring a specific section of the codebase
test: Everything related to testing
docs: Everything related to documentation

Example commit message:
feat: added report confessions option

Community:

Join the dev community for contributing to the project https://discord.gg/CzvcuUdx