ci: project is ready for contribution

Author: AdityaKumar5155

.github/Contributor_Guide/Contributing.md

@@ -10,7 +10,7 @@ If you are new to InsecureNet, please take a look at the [documentation](./Proje
 
 ## New Contributor Guide
 
-To get an overview of the codebase, check out the '[README.md](../src/README.md)' file in the `src` directory.
+To get an overview of the codebase, check out the '[README.md](../../app/README.md)' file in the `app` directory.
 
 that will help you understand the structure of the project.
 
@@ -32,6 +32,11 @@ If you want to contribute to InsecureNet, submit a pull request.
 
 ### Requirements
 
+Node.Js
 
 ### Setup
 
+Step-1:- run "npm i" in the repository root directory (Insecure/)
+Step-2:- Go to app directory with `cd app`
+Step-3:- run "npm i" in the app directory(Insecure/app)
+Step-4:- run "npm run dev" to start the server on the localhost:4444

.github/Contributor_Guide/Project_Tour.md

@@ -1,12 +1,10 @@
 # Project Tour
 
-* notes:
-*  > Discuss about your project file structure
-*  > what each folder is responsible
-*  > then go through each file in folders and explain there purpose
-*  > if possible create a doc system ( there are autogen docs available for most of the languages )
-*  > decide coding style , linting style and formatting style and other themes like variable naming etc.
-*  > provide an example for existing function and tests system if possible 
-*  
+## FILE STRUCTURE:-
 
-# MAKE SURE PROJECT MANAGERS UPDATE THIS MD 
+*  > InsecureNet/app: It contains webapp and all its files
+*  > InsecureNet/app/db: It contains database connection
+*  > InsecureNet/app/public: It contains all the css styling files
+*  > InsecureNet/app/routes: It contains route.js contains all the webapp routes
+*  > InsecureNet/app/views: It contains all the ejs files which is basically (HTML + JS) in a single file
+*  > InsecureNet/app/main.js: This is the main file used to start the application

README.md

@@ -1,2 +1,9 @@
-# template
-Template Repository for OpenSpringFest
+# InsecureNet
+
+This is a simple web app seeking contribution for the Frontend as well as in backend.
+
+If you want more information regarding the project you can read the [Project Documentation](./.github/Contributor_Guide/Project_Tour.md)
+
+Copyright (c)
+HackElite
+IIITBH. All rights reserved