Merge pull request #158 from ishivanshgoel/main

create readme + remove redundant code

Author: karanysingh

.gitignore

@@ -25,3 +25,5 @@ src/services/google-firebase/firebase_config.json
 .eslintcache
 .firebase 
 
+.vscode
+debug.log

.vscode/settings.json

@@ -1,10 +1,43 @@
-# Getting Started with Create React App
+<p align="center">
+  <img src="https://github.com/technocrats-robotics/tcr-website/blob/main/public/TcrLogoClean.png" width="128"/>
+</p>
 
-This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+<p align="center">
+  https://technocratsrobotics.in/
+</p>
 
-## Available Scripts
+<p align="center">
+  🚀 Website of Team Technocrats Robotics - VIT Chennai
+</p>
 
-In the project directory, you can run:
+<p align="center">
+  Made with ❤️ by technocrats robotics. 
+  <br>
+  #GoTCR
+</p>
+
+## Technologies Used
+<img src="https://img.shields.io/badge/-JavaScript-%23F7DF1E?logo=javascript&logoColor=black&style=for-the-badge" alt="JavaScript" /><img src="https://img.shields.io/badge/-React-%2361DAFB?logo=react&logoColor=black&style=for-the-badge" alt="React" />
+
+
+## Architecture
+<img src="https://github.com/ishivanshgoel/tcr-website/blob/main/docs/docs_1.png"/>
+
+On a high level, this website is divided into three parts
+- <b>Team Portfolio:</b> This section contains general information about our team like our achievements, team members, faculty coordinator, team's gallery, location of our garage, contact us form, our social media handles etc.
+- <b>User Panel:</b> This panel is used by our team members to manage their profile display badge in the team's portfolio.
+- <b>Admin Panel:</b> This section is used by our management department to create accounts for new recruits, manage roles of all the team members.
+
+## Developers
+### Batch of 2021
+- <p>🚀 Rahul Bera</p>
+- <p>🚀 Karan Yuvraj Singh</p>
+- <p>🚀 Ishika Naik</p>
+- <p>🚀 Shivansh Goel</p>
+
+<i>Juniors, keep adding your names here</i>
+
+## Development 
 
 ### `npm start`
 
@@ -14,11 +47,6 @@ Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
 The page will reload if you make edits.\
 You will also see any lint errors in the console.
 
-### `npm test`
-
-Launches the test runner in the interactive watch mode.\
-See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
-
 ### `npm run build`
 
 Builds the app for production to the `build` folder.\
@@ -29,42 +57,3 @@ Your app is ready to be deployed!
 
 See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
 
-### `npm run eject`
-
-**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
-
-If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
-
-Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
-
-You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
-
-## Learn More
-
-You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
-
-To learn React, check out the [React documentation](https://reactjs.org/).
-
-### Code Splitting
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)
-
-### Analyzing the Bundle Size
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)
-
-### Making a Progressive Web App
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)
-
-### Advanced Configuration
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)
-
-### Deployment
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)
-
-### `npm run build` fails to minify
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)

README.md

@@ -5,9 +5,7 @@ import * as React from "react";
 import LandingPage from "./pages/LandingPage.jsx";
 import AdminPanel from "./adminPanel/AdminPanel.jsx";
 import UserPanel from "./userPanel/UserPanel";
-import Blogs from "./pages/Blog";
 import TeamMembers from "./pages/TeamMembers";
-import Acheivements from "./components/Acheivements";
 import Developers from "./pages/Developers";
 // import Recruitments from "./pages/Recruitments/Recruitments";
 
@@ -28,9 +26,7 @@ function App() {
           <Route path="/adminPanel" component={AdminPanel} />
           <Route path="/userPanel" component={UserPanel} />
           <Route exact path="/developers" component={Developers} />
-          <Route exact path="/blogs" component={Blogs} />
           <Route exact path="/team" component={TeamMembers} />
-          <Route exact path="/acheivements" component={Acheivements} />
           {/* <Route exact path="/recruitments" component={Recruitments} /> */}
           <script src="/node_modules/rive-canvas/rive.js"></script>
         </Switch>

debug.log

@@ -10,7 +10,7 @@ import { admin_email } from "../constants";
 import FullPageLoader from "../components/LoadingScreen/FullPageLoader";
 
 //waring message hook
-import Warning from "../components/messages/Warning"; //(autmatically disappers after 3000 ms)
+import Warning from "../components/Messages/Warning"; //(autmatically disappers after 3000 ms)
 
 function AdminLogin() {
   //state variables

docs/docs_1.png

@@ -1,5 +1,5 @@
-export { Success } from "./messages"
-export { Warning } from "./messages"
+export { Success } from "./Messages"
+export { Warning } from "./Messages"
 // export { default as Loader } from "./Loader"
 export { default as Acheivements } from "./Acheivements"
 export { default as BlogCards } from "./BlogCards"

src/App.js

@@ -5,10 +5,10 @@ import "./CSS/changePassword.css";
 import { changePassword } from "../services/google-firebase/utilities";
 
 //success message hook
-import Success from "../components/messages/Success";
+import Success from "../components/Messages/Success";
 
 //warning message hook
-import Warning from "../components/messages/Warning";
+import Warning from "../components/Messages/Warning";
 
 //loading screen hook
 import FullPageLoader from "../components/LoadingScreen/FullPageLoader";