Skip to content

GETTING_STARTED.md

Latest commit

 

History

History
211 lines (122 loc) · 5.49 KB

GETTING_STARTED.md

File metadata and controls

211 lines (122 loc) · 5.49 KB

Get Started with NotesVault Contribution

NotesVault is an open-source web application designed to help college students easily access and manage academic notes and previous year questions (PYQs) for all branches and semesters.

This project is built by students, for students — with the goal of creating a centralized and reliable resource hub for our college community.

Whether you’re looking to explore open source, improve your web development skills, or give back to the community — NotesVault is the perfect place to start.

✨ Why Contribute?

  • You help students across semesters access useful study material
  • You learn and grow by contributing to a real project
  • You get recognized for your contributions
  • You become part of a collaborative developer community

🛠️ Prerequisites

Before you start contributing to NotesVault, make sure you have the following:

✅ Basic Knowledge

  • Familiarity with HTML, CSS, and JavaScript
  • Basic understanding of how Git and GitHub work (forking, cloning, pull requests)

🧰 Tools Required

  • A GitHub account – Create one here if you don’t have one
  • Code editor – We recommend VS Code
  • Git installed on your system – Download Git
  • A modern web browser – Chrome, Firefox, or Edge

🚫 No Frameworks Needed

This is a beginner-friendly project — no frameworks, no backend required.
You just open index.html in your browser and start building!

🔧 Setup Instructions

Follow these steps to get NotesVault running on your local machine:

📌 Step 1: Fork the Repository

Go to the NotesVault GitHub repo and click on the Fork button in the top right corner. This will create a copy of the project under your GitHub account.

📥 Step 2: Clone Your Fork

Open your terminal and run the following commands:

git clone https://github.com/YOUR_USERNAME/NotesVault.git
cd NotesVault

Replace YOUR_USERNAME with your actual GitHub username.

🧪 Step 3: Run the Project

Since NotesVault is a static web app, you don't need any server or build tool.

Just open the index.html file in your browser:

  • Right-click on index.html and select "Open with" > your browser, or
  • Drag and drop the file into a browser window

You should now see the NotesVault homepage running locally.

💡 Where to Start

Once you have the project running locally, it’s time to explore and start contributing!

🔎 Explore Open Issues

Visit the Issues tab on GitHub to see tasks available for contribution.

We tag beginner-friendly ones as good first issue or help wanted.
Pick one you're comfortable with and start working!

🔁 Contribution Workflow

Follow this step-by-step workflow to make your first contribution to NotesVault:

🌿 Step 1: Create a New Branch

Always create a new branch for your feature or fix:

git checkout -b my-feature-branch

Replace my-feature-branch with a short, meaningful name.

✍️ Step 2: Make Your Changes

  • Edit files (HTML, CSS, JS, or JSON) as needed
  • Test your changes locally by refreshing index.html in the browser

✅ Step 3: Stage and Commit

After making your changes:

git add .
git commit -m "Add: your short and clear message"

Use meaningful commit messages that describe what you changed.

📤 Step 4: Push Your Branch

Push your changes to your forked GitHub repo:

git push origin my-feature-branch

🚀 Step 5: Open a Pull Request

  1. Go to your fork on GitHub
  2. Click “Compare & pull request”
  3. Write a short title and description of your changes
  4. Submit the pull request to the main branch of the original repo

Once your PR is reviewed and approved, it will be merged into the project!

📚 Guidelines & Tips

To keep contributions consistent and the project healthy, please follow these simple guidelines:

🧼 Code Quality

  • Keep your code clean and readable
  • Use proper indentation and spacing
  • Write semantic HTML and reusable CSS
  • Comment your code where necessary

✍️ Commit Messages

  • Use clear, meaningful commit messages
  • Prefer short prefixes like Add:, Fix:, Update:, Refactor: etc.

Example:

git commit -m "Add: responsive layout for home page"

💬 Be Respectful

  • Be polite and constructive in discussions, issues, and reviews
  • Respect others’ time and contributions
  • Follow our Code of Conduct

🔗 Useful Links

🙌 Community Support

You're not alone! If you ever feel stuck or unsure about where to begin, we're here to help.

📣 Ask for Help

  • Drop your questions in the Discussions tab on GitHub
  • Reach out in our community WhatsApp group (link shared in README or repo)
  • Comment on the issue you're working on if you need clarification

🤝 Collaboration Tips

  • Communicate before working on large changes
  • Feel free to suggest improvements or raise ideas
  • Review others’ pull requests and learn together

We’re building NotesVault as a team — for the students, by the students.
Let’s collaborate, learn, and grow together!