Skip to content

This repository is officially part of GirlScript Summer of Code 2024 Extended Edition! Enyanjyoti platform serves as a one stop solution for conceptual learning, career and employment opportunities and information about loans and grants

License

Notifications You must be signed in to change notification settings

riyaaryan2004/Enyanjyoti

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

22 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🎉 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 essential information about financial support. Join us in building a platform that empowers learners and professionals alike!


Table of Contents

  1. Getting Started
  2. Available Scripts
  3. How to Contribute
  4. Code of Conduct
  5. Issues
  6. Pull Requests
  7. Additional Resources

🚀 Getting Started

This project was bootstrapped using Create React App. Follow the steps below to set up the project locally:

Prerequisites

Make sure you have the following installed:

Installation

  1. Clone the repository:

    git clone https://github.com/your-repo/enyanjyoti.git
    cd enyanjyoti
  2. Install dependencies:

    npm install
  3. Start the development server:

    npm start

The app should now be running at http://localhost:3000.


🛠️ Available Scripts

In the project directory, you can run the following scripts:

npm start ⚙️

Runs the app in development mode.

  • Open http://localhost:3000 to view it in your browser.
  • The page will reload when edits are made.
  • Console will display lint errors, if any.

npm test 🧪

Runs the test suite in watch mode.

npm run build 🏗️

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.

For more scripts and configurations, refer to the official Create React App documentation.


📥 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:
    git checkout -b branch_name
  3. Make your changes and commit them:
    git commit -m "Add your detailed message here"
  4. Push to your branch:
    git push origin main
  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 of Conduct

We follow the Contributor Covenant Code of Conduct. Please read it before contributing.


🐛 Issues

Found a bug? Want to request a feature? Head over to the Issues section 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


Happy Coding! 😄

About

This repository is officially part of GirlScript Summer of Code 2024 Extended Edition! Enyanjyoti platform serves as a one stop solution for conceptual learning, career and employment opportunities and information about loans and grants

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 88.5%
  • CSS 9.3%
  • HTML 2.2%