Project Title:

"Collaborative E-learing Platform for Competitive Programming"

---------------------------------------------------------------------------------------------------------
Application Name:

"Meet2Code"
---------------------------------------------------------------------------------------------------------

---------------------------------------------------------------------------------------------------------
Software Required:

To develop the application:

1) React JS
2) Node
3) Javascript
4) VS code/ IntelliJ (any comfortable code Editor)
5) Google Chrome Browser with cookie enabled.
6) Mongo DB
7) Google cloud platform Oauth Credentials.
8) Git Oauth Credentials.

To deploy the application: 

9) Git
10) Mongo Atlas
11) Heroku
12) Netlify

To use the app the user needs the following:

13) Google / github account.
14) Cookie enabled browser.
---------------------------------------------------------------------------------------------------------

---------------------------------------------------------------------------------------------------------
Hardware Requirements:

To develop the Application:
1) Laptop/ Desktop.

To deploy the Application:
2) Two servers with static IP address.(if needed) 

To use the app the user needs the following:

3) Camera.
4) Mic.
5) Laptop or Desktop (no mobile devices).
6) Mouse and Keyboard pheripherals. (as needed).
---------------------------------------------------------------------------------------------------------

---------------------------------------------------------------------------------------------------------
To Start the app:

For Environment Setup:

1) Download Visual Studio Code from "https://code.visualstudio.com/download".
2) Download Node JS LTS from "https://nodejs.org/en/download/". Follow the download instructions for the same.
3) Make sure Npx is available else update npm with "npm i -g npm" in the command line.
4) Download Mongo DB from "https://www.mongodb.com/try/download/community"
5) Get the source code into a folder.
6) Create Git and google Oauth Credential and upload to config.js file in backend.
7) Update your created Urls and ports in place of existing ones in all config.js files available in frontend and backend.

For the developers:

1) For local testing go to TestEnv and install libraries with "npm install" inside frontend and backend directories.
2) For loacl testing start frontend and backend with "npm start" command in their respective folders under TestEnv.
3) For Local testing use "localhost:3000" for frontend (default) and "localhost:9000" for backend(default).
4) For deployment update the code after testing in testEnv to deployment Env and create a push and merge to main to deploy changes automatically.
5) For debugging go to heroku for backend and netlify for frontend where you have deployed your app.

For the users:

1) Start google chrome.
2) Go to "meet2code.netlify.app".
3) Ensure cookies are turned on.
4) Login with Google or Git and start using.

Note:

"npm install" in frontend may take some time, data(around 500MB) and storage(around 1.5GB). So make sure the system and network requirements are available before execcuting this command.
---------------------------------------------------------------------------------------------------------