-
Notifications
You must be signed in to change notification settings - Fork 155
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #23 from rishyym0927/#ssue6
Update README.md Fixes #6
- Loading branch information
Showing
1 changed file
with
113 additions
and
38 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,70 +1,145 @@ | ||
| # Getting Started with Create React App | ||
|
|
||
| This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). | ||
| # 🎉 Welcome to the Enyanjyoti Platform! 🌟 | ||
|
|
||
| ## Available Scripts | ||
| This repository is part of **GirlScript Summer of Code 2024 Extended Edition!** 🚀 | ||
|
|
||
| In the project directory, you can run: | ||
| Enyanjyoti serves as a **one-stop solution** for: | ||
| - 📚 **Conceptual Learning** | ||
| - 💼 **Career and Employment Opportunities** | ||
| - 💰 **Information about Loans and Grants** | ||
|
|
||
| ### `npm start` | ||
| 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! | ||
|
|
||
| Runs the app in the development mode.\ | ||
| Open [http://localhost:3000](http://localhost:3000) to view it in your browser. | ||
| --- | ||
|
|
||
| The page will reload when you make changes.\ | ||
| You may also see any lint errors in the console. | ||
| ## 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) | ||
|
|
||
| ### `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. | ||
| ## 🚀 Getting Started | ||
|
|
||
| ### `npm run build` | ||
| 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: | ||
|
|
||
| Builds the app for production to the `build` folder.\ | ||
| It correctly bundles React in production mode and optimizes the build for the best performance. | ||
| ### Prerequisites | ||
|
|
||
| The build is minified and the filenames include the hashes.\ | ||
| Your app is ready to be deployed! | ||
| Make sure you have the following installed: | ||
| - [Node.js](https://nodejs.org/en/) (v14 or above) | ||
| - [npm](https://www.npmjs.com/get-npm) | ||
|
|
||
| See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. | ||
| ### Installation | ||
|
|
||
| ### `npm run eject` | ||
| 1. Clone the repository: | ||
| ```bash | ||
| git clone https://github.com/your-repo/enyanjyoti.git | ||
| cd enyanjyoti | ||
| ``` | ||
|
|
||
| **Note: this is a one-way operation. Once you `eject`, you can't go back!** | ||
| 2. Install dependencies: | ||
| ```bash | ||
| npm install | ||
| ``` | ||
|
|
||
| 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. | ||
| 3. Start the development server: | ||
| ```bash | ||
| npm start | ||
| ``` | ||
|
|
||
| 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. | ||
| The app should now be running at [http://localhost:3000](http://localhost:3000). | ||
|
|
||
| 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 | ||
| ## 🛠️ Available Scripts | ||
|
|
||
| You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started). | ||
| In the project directory, you can run the following scripts: | ||
|
|
||
| To learn React, check out the [React documentation](https://reactjs.org/). | ||
| ### **`npm start`** ⚙️ | ||
| Runs the app in development mode. | ||
| - Open [http://localhost:3000](http://localhost:3000) to view it in your browser. | ||
| - The page will reload when edits are made. | ||
| - Console will display lint errors, if any. | ||
|
|
||
| ### Code Splitting | ||
| ### **`npm test`** 🧪 | ||
| Runs the test suite in watch mode. | ||
| - [Running Tests](https://facebook.github.io/create-react-app/docs/running-tests) | ||
|
|
||
| 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) | ||
| ### **`npm run build`** 🏗️ | ||
| Builds the app for **production** into the `build` folder. | ||
| - The build is optimized for performance. | ||
| - Generates minified bundles with hashed filenames. | ||
|
|
||
| ### Analyzing the Bundle Size | ||
| ### **`npm run eject`** 🔧 | ||
| **Warning**: Irreversible. Ejects the app from Create React App configuration and gives full control over Webpack and Babel settings. | ||
|
|
||
| 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) | ||
| For more scripts and configurations, refer to the [official Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started). | ||
|
|
||
| ### 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) | ||
| ## 📥 How to Contribute | ||
|
|
||
| ### Advanced Configuration | ||
| We welcome contributions to the Enyanjyoti platform! To get started: | ||
|
|
||
| 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) | ||
| 1. Fork the repository. | ||
| 2. Create a new branch with a descriptive name: | ||
| ```bash | ||
| git checkout -b branch_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 main | ||
| ``` | ||
| 5. Create a pull request to the main branch. | ||
|
|
||
| ### Deployment | ||
| ### 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. | ||
|
|
||
| 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 | ||
| ## 📜 Code of Conduct | ||
|
|
||
| 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) | ||
| We follow the [Contributor Covenant Code of Conduct](https://www.contributor-covenant.org/version/2/0/code_of_conduct/). Please read it before contributing. | ||
|
|
||
| --- | ||
|
|
||
| ## 🐛 Issues | ||
|
|
||
| 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. | ||
|
|
||
| --- | ||
|
|
||
| ## 🔄 Pull Requests | ||
|
|
||
| All contributions are made through pull requests. To submit a pull request, follow these steps: | ||
|
|
||
| 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. | ||
|
|
||
| --- | ||
|
|
||
| ## 📚 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! 😄 |