From deac651924cbd6c707a43f8a5f80eb0ff1f708e9 Mon Sep 17 00:00:00 2001 From: RISHIRAJ MUKHERJEE <136720020+rishyym0927@users.noreply.github.com> Date: Fri, 4 Oct 2024 17:38:49 +0530 Subject: [PATCH 1/3] Update README.md Fixes #6 --- README.md | 85 ++++++++++++++++++++++++++++++------------------------- 1 file changed, 47 insertions(+), 38 deletions(-) diff --git a/README.md b/README.md index 58beeac..6e9c0af 100644 --- a/README.md +++ b/README.md @@ -1,70 +1,79 @@ -# Getting Started with Create React App +# ๐ŸŽ‰ Welcome to Enyanjyoti Platform! ๐ŸŒŸ -This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). +This repository is officially part of **GirlScript Summer of Code 2024 Extended Edition!** ๐Ÿš€ -## Available Scripts +Enyanjyoti serves as a **one-stop solution** for: +- ๐Ÿ“š **Conceptual Learning** +- ๐Ÿ’ผ **Career and Employment Opportunities** +- ๐Ÿ’ฐ **Information about Loans and Grants** -In the project directory, you can run: +We aim to bridge the gap between education and employment while providing crucial information about financial support. Join us in building a platform that empowers learners and professionals alike! -### `npm start` +## ๐Ÿš€ Getting Started with Create React App -Runs the app in the development mode.\ -Open [http://localhost:3000](http://localhost:3000) to view it in your browser. +This project was bootstrapped using [Create React App](https://github.com/facebook/create-react-app). -The page will reload when you make changes.\ -You may also see any lint errors in the console. +### ๐Ÿ› ๏ธ Available Scripts -### `npm test` +In the project directory, you can run the following scripts: -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 start`** โš™๏ธ -### `npm run build` +Runs the app in development mode. +- Open [http://localhost:3000](http://localhost:3000) to view it in your browser. +- The page automatically reloads when you make edits. +- Any lint errors will appear in the console. -Builds the app for production to the `build` folder.\ -It correctly bundles React in production mode and optimizes the build for the best performance. +### **`npm test`** ๐Ÿงช -The build is minified and the filenames include the hashes.\ -Your app is ready to be deployed! +Launches the test runner in interactive watch mode. +- More details: [Running Tests](https://facebook.github.io/create-react-app/docs/running-tests) -See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. +### **`npm run build`** ๐Ÿ—๏ธ -### `npm run eject` +Builds the app for **production** into the `build` folder. +- The build is optimized for the **best performance**. +- It creates minified bundles with filenames that include the hashes. -**Note: this is a one-way operation. Once you `eject`, you can't go back!** +Your app is now **ready to be deployed**! ๐Ÿš€ +- For more on deploying, check out the [Deployment Guide](https://facebook.github.io/create-react-app/docs/deployment). -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. +### **`npm run eject`** ๐Ÿ”ง -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. +**Warning:** This is a one-way operation. Once you eject, you can't go back! +- It gives you full control over the build configuration (Webpack, Babel, etc.). +- Use this when you need to customize the build tool and configuration. -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 -## Learn More +Want to dive deeper? Explore the official documentation: +- [Create React App Documentation](https://facebook.github.io/create-react-app/docs/getting-started) +- [React Documentation](https://reactjs.org/) -You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started). +### ๐Ÿ“ฆ Code Splitting -To learn React, check out the [React documentation](https://reactjs.org/). +Learn how to optimize your app with [Code Splitting](https://facebook.github.io/create-react-app/docs/code-splitting). -### Code Splitting +### ๐Ÿ“ Analyzing Bundle Size -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) +Check out how to [analyze the bundle size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size) to ensure your app is fast and lean. -### Analyzing the Bundle Size +### ๐Ÿ–ฅ๏ธ Progressive Web App (PWA) -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) +Learn how to make your app a [PWA](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app) for offline capabilities and improved performance. -### Making a Progressive Web App +### ๐Ÿ”ง Advanced Configuration -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) +For advanced customization, see [Advanced Configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration). -### Advanced Configuration +### ๐ŸŒ Deployment -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) +Learn how to deploy your app for production [here](https://facebook.github.io/create-react-app/docs/deployment). -### Deployment +### ๐Ÿ› ๏ธ `npm run build` Fails to Minify? -This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment) +If you encounter build issues, check the troubleshooting guide [here](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify). -### `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) +Happy coding! ๐Ÿ˜„ From b5df38b796490fc652fa11cd0025b128ecb94622 Mon Sep 17 00:00:00 2001 From: RISHIRAJ MUKHERJEE <136720020+rishyym0927@users.noreply.github.com> Date: Fri, 4 Oct 2024 17:57:36 +0530 Subject: [PATCH 2/3] Update README.md --- README.md | 146 +++++++++++++++++++++++++++++++++++++++--------------- 1 file changed, 106 insertions(+), 40 deletions(-) diff --git a/README.md b/README.md index 6e9c0af..5ac6fa0 100644 --- a/README.md +++ b/README.md @@ -1,79 +1,145 @@ -# ๐ŸŽ‰ Welcome to Enyanjyoti Platform! ๐ŸŒŸ -This repository is officially part of **GirlScript Summer of Code 2024 Extended Edition!** ๐Ÿš€ +# ๐ŸŽ‰ Welcome to the Enyanjyoti Platform! ๐ŸŒŸ + +This repository is part of **GirlScript Summer of Code 2024 Extended Edition!** ๐Ÿš€ Enyanjyoti serves as a **one-stop solution** for: - ๐Ÿ“š **Conceptual Learning** - ๐Ÿ’ผ **Career and Employment Opportunities** - ๐Ÿ’ฐ **Information about Loans and Grants** -We aim to bridge the gap between education and employment while providing crucial information about financial support. Join us in building a platform that empowers learners and professionals alike! +We aim to bridge the gap between education and employment while providing essential information about financial support. Join us in building a platform that empowers learners and professionals alike! + +--- + +## Table of Contents +1. [Getting Started](#getting-started) +2. [Available Scripts](#available-scripts) +3. [How to Contribute](#how-to-contribute) +4. [Code of Conduct](#code-of-conduct) +5. [Issues](#issues) +6. [Pull Requests](#pull-requests) +7. [Additional Resources](#additional-resources) + +--- + +## ๐Ÿš€ Getting Started + +This project was bootstrapped using [Create React App](https://github.com/facebook/create-react-app). Follow the steps below to set up the project locally: + +### Prerequisites + +Make sure you have the following installed: +- [Node.js](https://nodejs.org/en/) (v14 or above) +- [npm](https://www.npmjs.com/get-npm) + +### Installation + +1. Clone the repository: + ```bash + git clone https://github.com/your-repo/enyanjyoti.git + cd enyanjyoti + ``` + +2. Install dependencies: + ```bash + npm install + ``` + +3. Start the development server: + ```bash + npm start + ``` -## ๐Ÿš€ Getting Started with Create React App +The app should now be running at [http://localhost:3000](http://localhost:3000). -This project was bootstrapped using [Create React App](https://github.com/facebook/create-react-app). +--- -### ๐Ÿ› ๏ธ Available Scripts +## ๐Ÿ› ๏ธ Available Scripts In the project directory, you can run the following scripts: ### **`npm start`** โš™๏ธ - -Runs the app in development mode. +Runs the app in development mode. - Open [http://localhost:3000](http://localhost:3000) to view it in your browser. -- The page automatically reloads when you make edits. -- Any lint errors will appear in the console. +- The page will reload when edits are made. +- Console will display lint errors, if any. ### **`npm test`** ๐Ÿงช - -Launches the test runner in interactive watch mode. -- More details: [Running Tests](https://facebook.github.io/create-react-app/docs/running-tests) +Runs the test suite in watch mode. +- [Running Tests](https://facebook.github.io/create-react-app/docs/running-tests) ### **`npm run build`** ๐Ÿ—๏ธ - -Builds the app for **production** into the `build` folder. -- The build is optimized for the **best performance**. -- It creates minified bundles with filenames that include the hashes. - -Your app is now **ready to be deployed**! ๐Ÿš€ -- For more on deploying, check out the [Deployment Guide](https://facebook.github.io/create-react-app/docs/deployment). +Builds the app for **production** into the `build` folder. +- The build is optimized for performance. +- Generates minified bundles with hashed filenames. ### **`npm run eject`** ๐Ÿ”ง +**Warning**: Irreversible. Ejects the app from Create React App configuration and gives full control over Webpack and Babel settings. -**Warning:** This is a one-way operation. Once you eject, you can't go back! -- It gives you full control over the build configuration (Webpack, Babel, etc.). -- Use this when you need to customize the build tool and configuration. +For more scripts and configurations, refer to the [official Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started). -### ๐ŸŒ Learn More +--- -Want to dive deeper? Explore the official documentation: -- [Create React App Documentation](https://facebook.github.io/create-react-app/docs/getting-started) -- [React Documentation](https://reactjs.org/) +## ๐Ÿ“ฅ How to Contribute + +We welcome contributions to the Enyanjyoti platform! To get started: + +1. Fork the repository. +2. Create a new branch with a descriptive name: + ```bash + git checkout -b feature/your-feature-name + ``` +3. Make your changes and commit them: + ```bash + git commit -m "Add your detailed message here" + ``` +4. Push to your branch: + ```bash + git push origin feature/your-feature-name + ``` +5. Create a pull request to the main branch. + +### Contribution Guidelines: +- Keep code clean and well-documented. +- Follow the coding style used in the project. +- Ensure that tests pass before submitting pull requests. +- Open an issue before working on new features. -### ๐Ÿ“ฆ Code Splitting +--- -Learn how to optimize your app with [Code Splitting](https://facebook.github.io/create-react-app/docs/code-splitting). +## ๐Ÿ“œ Code of Conduct -### ๐Ÿ“ Analyzing Bundle Size +We follow the [Contributor Covenant Code of Conduct](https://www.contributor-covenant.org/version/2/0/code_of_conduct/). Please read it before contributing. -Check out how to [analyze the bundle size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size) to ensure your app is fast and lean. +--- -### ๐Ÿ–ฅ๏ธ Progressive Web App (PWA) +## ๐Ÿ› Issues -Learn how to make your app a [PWA](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app) for offline capabilities and improved performance. +Found a bug? Want to request a feature? Head over to the [Issues section](https://github.com/your-repo/issues) and let us know. Please check if the issue already exists before submitting a new one. -### ๐Ÿ”ง Advanced Configuration +--- -For advanced customization, see [Advanced Configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration). +## ๐Ÿ”„ Pull Requests -### ๐ŸŒ Deployment +All contributions are made through pull requests. To submit a pull request, follow these steps: -Learn how to deploy your app for production [here](https://facebook.github.io/create-react-app/docs/deployment). +1. Fork and clone the repo. +2. Create a new branch for your feature. +3. Make sure your code adheres to the project's coding guidelines. +4. Submit your pull request and wait for it to be reviewed. -### ๐Ÿ› ๏ธ `npm run build` Fails to Minify? +--- -If you encounter build issues, check the troubleshooting guide [here](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify). +## ๐Ÿ“š Additional Resources +- [Create React App Documentation](https://facebook.github.io/create-react-app/docs/getting-started) +- [React Documentation](https://reactjs.org/) +- [Code Splitting](https://facebook.github.io/create-react-app/docs/code-splitting) +- [Analyzing Bundle Size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size) +- [Making a Progressive Web App](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app) +- [Deployment Guide](https://facebook.github.io/create-react-app/docs/deployment) + --- -Happy coding! ๐Ÿ˜„ +Happy Coding! ๐Ÿ˜„ From cbc0832d933135d8234d1f2696a26d93c0936969 Mon Sep 17 00:00:00 2001 From: SK MIRAJUL ISLAM <122096119+skmirajulislam@users.noreply.github.com> Date: Fri, 4 Oct 2024 21:21:07 +0530 Subject: [PATCH 3/3] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5ac6fa0..70c918d 100644 --- a/README.md +++ b/README.md @@ -88,7 +88,7 @@ We welcome contributions to the Enyanjyoti platform! To get started: 1. Fork the repository. 2. Create a new branch with a descriptive name: ```bash - git checkout -b feature/your-feature-name + git checkout -b branch_name ``` 3. Make your changes and commit them: ```bash @@ -96,7 +96,7 @@ We welcome contributions to the Enyanjyoti platform! To get started: ``` 4. Push to your branch: ```bash - git push origin feature/your-feature-name + git push origin main ``` 5. Create a pull request to the main branch.