Skip to content

Latest commit

 

History

History
278 lines (204 loc) · 10.4 KB

README.md

File metadata and controls

278 lines (204 loc) · 10.4 KB
Raw

🎉 Welcome to the E-nyanjyoti Platform! 🌟

This repository is part of GirlScript Summer of Code 2024 Extended Edition & hacktoberfest 2024! 🚀

GitHub Readme Profile Issues GitHub Readme Profile PRs

E-nyanjyoti 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!

Featured In

Event Logo Event Name Event Description
GSSoC Ext 24 GirlScript Summer of Code Ext 2024 GSSOC Ext is a one-month-long open-source program by the GirlScript Foundation that runs from October 1 to November 10, 2024
Hacktoberfest 24 Hacktoberfest 2024 Hacktober Fest is an annual celebration of open-source software development. It's a month-long event encouraging developers to contribute to open-source projects.

Our Top Contributors

  • We extend our heartfelt gratitude for your invaluable contribution to our project! Your efforts play a pivotal role in elevating E-nyanjyoti to a greater heights.
  • Make sure you show some love by giving ⭐ to our repository.

Contributors Thank you for your contributions!

- : Officially Part of GSSoC'24-Extd & hacktoberfest 2024 : -

Table of Contents

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

🚀 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:

Project Set Up

  1. 🍴 Fork this repository.
  • Click the Fork button at the top-right corner of this repository page to create a copy of the repository under your GitHub account.
  1. 📥 Clone the repository:
   git clone https://github.com/<your-username>/enyanjyoti.git
  1. 📂 Change the working directory:
   cd enyanjyoti
  1. 🔗 Add a reference to the original repository.
   git remote add upstream https://github.com/Vin205/Enyanjyoti.git
  1. 🔍 Check the remotes for this repository.
   git remote -v
  1. ⬇️ Always take a pull from the upstream repository to your main branch to keep it up-to-date with the main project (updated repository).
   git pull upstream main
  1. 🌿 Create a new branch.
   git checkout -b <your-branch-name>
  1. 🛠️ Install dependencies:
   npm install
   npm install swiper@latest
  1. 📊 Start the development server:
   npm start

You are all set! 🎉 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

🐛 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.

We welcome contributions to the Enyanjyoti platform! To get started:

  1. Set up the project. (Refer to the Project set up guide for the same)

  2. Perform your desired changes to the code base.

  3. Track your changes.

   git add .
  1. Commit your changes with a relevant commit message.
    git commit -m "Add feature X"

Or if you fixed a bug, you could use:

    git commit -m "Fix issue Y"
  1. Push the commited changes in your branch to your remote repo:
   git push origin main
  1. Create a pull request to the main branch.
  • Go to your forked repository on GitHub and click on Compare & pull request.

🎉 Voila! You have made a PR to the Enyanjyoti project. Sit back patiently and relax while the project maintainers review your PR.

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.

for more details of contribution follow this link - How to Contribute

📜 Code of Conduct

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

🔄 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

Project Admin & Mentor assigned under GSSoC ext & Hacktoberfest 2024

Feel free to ask, and don’t hesitate to raise your problem. They are always ready to help you!

Project Admin Profile Picture

Vinisha Dsouza

Project Admin

 Project Mentor Profile Picture

Sk Mirajul Islam

Project Mentor

Happy Coding! 😄