From d97692061ec9cfeb21c5085269b87e8f52d88c6b Mon Sep 17 00:00:00 2001 From: Sangram Das <121278559+Sangram03@users.noreply.github.com> Date: Wed, 4 Dec 2024 18:58:09 +0530 Subject: [PATCH 1/3] Create README.md new readme file updates --- README.md | 96 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 96 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..b6186eb --- /dev/null +++ b/README.md @@ -0,0 +1,96 @@ + +--- + +# Project + +A full-stack web application project with a **frontend** built in React and a **backend** implemented using Node.js. + +## Folder Structure + +### Backend +The backend contains the server-side logic and APIs. + +**Folder: `backend`** +- **`insertAdmin.js`**: Script for inserting admin-related data. +- **`insertData.js`**: Script for seeding initial data. +- **`insertDept.js`**: Script for department-related data. +- **`model.js`**: Database models and schemas. +- **`server.js`**: Main server entry point. +- **`package.json`**: Dependencies and scripts for the backend. + +### Frontend +The frontend is a React-based single-page application. + +**Folder: `frontend`** +- **`public`** + - Static files such as `favicon.ico`, `index.html`, and manifest-related files. +- **`src`** + - **`App.js`**: Main application component. + - **`Pages`**: Directory for different page components. + - **`index.js`**: Entry point for React app. + - **`App.css`**, **`index.css`**: Styling files. + - **`reportWebVitals.js`**: Performance tracking for React. + +## How to Run the Project + +### Prerequisites +- Node.js (version 14.x or higher) +- npm or yarn installed + +### Backend +1. Navigate to the `backend` directory: + ```bash + cd backend + ``` +2. Install dependencies: + ```bash + npm install + ``` +3. Start the server: + ```bash + npm start + ``` + +### Frontend +1. Navigate to the `frontend` directory: + ```bash + cd frontend + ``` +2. Install dependencies: + ```bash + npm install + ``` +3. Start the React development server: + ```bash + npm start + ``` + +### Run Both Frontend and Backend +Ensure both servers are running concurrently on separate ports. + +## Features +- **Frontend**: Interactive UI built with React. +- **Backend**: RESTful API endpoints for data management. +- **Full Stack Integration**: Seamless communication between the frontend and backend. + +## Contributing +1. Fork the repository. +2. Create a feature branch: + ```bash + git checkout -b feature-name + ``` +3. Commit your changes: + ```bash + git commit -m "Add feature" + ``` +4. Push to the branch: + ```bash + git push origin feature-name + ``` +5. Create a Pull Request. + +## License +This project is open-source and available under the MIT License. + +--- + From 05d8348158b55098590fb73b1268d6d7660eca5f Mon Sep 17 00:00:00 2001 From: Sangram Das <121278559+Sangram03@users.noreply.github.com> Date: Wed, 4 Dec 2024 19:00:49 +0530 Subject: [PATCH 2/3] Update README.md with emoji --- README.md | 81 ++++++++++++++++++++++++++++++------------------------- 1 file changed, 45 insertions(+), 36 deletions(-) diff --git a/README.md b/README.md index b6186eb..ae55449 100644 --- a/README.md +++ b/README.md @@ -1,43 +1,46 @@ ---- -# Project +# 🚀 **Project** A full-stack web application project with a **frontend** built in React and a **backend** implemented using Node.js. -## Folder Structure +## 📂 **Folder Structure** -### Backend +### 🔧 **Backend** The backend contains the server-side logic and APIs. **Folder: `backend`** -- **`insertAdmin.js`**: Script for inserting admin-related data. -- **`insertData.js`**: Script for seeding initial data. -- **`insertDept.js`**: Script for department-related data. -- **`model.js`**: Database models and schemas. -- **`server.js`**: Main server entry point. -- **`package.json`**: Dependencies and scripts for the backend. - -### Frontend +- **`insertAdmin.js`**: 🛠 Script for inserting admin-related data. +- **`insertData.js`**: 📦 Script for seeding initial data. +- **`insertDept.js`**: 🏢 Script for department-related data. +- **`model.js`**: 📄 Database models and schemas. +- **`server.js`**: 🚀 Main server entry point. +- **`package.json`**: 📜 Dependencies and scripts for the backend. + +### 🌐 **Frontend** The frontend is a React-based single-page application. **Folder: `frontend`** - **`public`** - - Static files such as `favicon.ico`, `index.html`, and manifest-related files. + - 🌟 `favicon.ico`: Favicon for the app. + - 📃 `index.html`: Entry HTML file. + - 📋 `manifest.json`: Manifest file for PWA settings. - **`src`** - - **`App.js`**: Main application component. - - **`Pages`**: Directory for different page components. - - **`index.js`**: Entry point for React app. - - **`App.css`**, **`index.css`**: Styling files. - - **`reportWebVitals.js`**: Performance tracking for React. + - **`App.js`**: ⚛️ Main application component. + - **`Pages`**: 📄 Directory for different page components. + - **`index.js`**: 🖥 Entry point for React app. + - **`App.css`**, **`index.css`**: 🎨 Styling files. + - **`reportWebVitals.js`**: 📊 Performance tracking for React. + +--- -## How to Run the Project +## 🛠 **How to Run the Project** ### Prerequisites -- Node.js (version 14.x or higher) -- npm or yarn installed +- 📦 **Node.js** (version 14.x or higher) +- 📥 **npm** or **yarn** installed -### Backend +### 🔧 Backend 1. Navigate to the `backend` directory: ```bash cd backend @@ -51,7 +54,7 @@ The frontend is a React-based single-page application. npm start ``` -### Frontend +### 🌐 Frontend 1. Navigate to the `frontend` directory: ```bash cd frontend @@ -65,32 +68,38 @@ The frontend is a React-based single-page application. npm start ``` -### Run Both Frontend and Backend +### 🚀 Run Both Frontend and Backend Ensure both servers are running concurrently on separate ports. -## Features -- **Frontend**: Interactive UI built with React. -- **Backend**: RESTful API endpoints for data management. -- **Full Stack Integration**: Seamless communication between the frontend and backend. +--- + +## 🌟 **Features** +- ⚛️ **Frontend**: Interactive UI built with React. +- 🛠 **Backend**: RESTful API endpoints for data management. +- 🔗 **Full Stack Integration**: Seamless communication between the frontend and backend. -## Contributing -1. Fork the repository. -2. Create a feature branch: +--- + +## 🤝 **Contributing** +1. 🍴 Fork the repository. +2. 🌱 Create a feature branch: ```bash git checkout -b feature-name ``` -3. Commit your changes: +3. 💾 Commit your changes: ```bash git commit -m "Add feature" ``` -4. Push to the branch: +4. 📤 Push to the branch: ```bash git push origin feature-name ``` -5. Create a Pull Request. +5. 📝 Create a Pull Request. -## License +--- + +## 📜 **License** This project is open-source and available under the MIT License. ---- +--- From 33f4622fdbcdb983b771ee886f3e467ac6eb88f3 Mon Sep 17 00:00:00 2001 From: Sangram Das <121278559+Sangram03@users.noreply.github.com> Date: Wed, 4 Dec 2024 19:07:26 +0530 Subject: [PATCH 3/3] Create LICENSE --- LICENSE | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..51ae597 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2024 Ramakanta Sahoo Bhabanjan Panda + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE.