From a4dcd53696b7d042c24d5afc8f25cbe2013f5cf6 Mon Sep 17 00:00:00 2001
From: Abhigna Arsam <125258286+Abhigna-arsam@users.noreply.github.com>
Date: Sun, 2 Jun 2024 12:29:32 +0530
Subject: [PATCH] Update README.md
---
README.md | 183 +++++++++++++++++++++++++++++++++++++++++++++++++++---
1 file changed, 173 insertions(+), 10 deletions(-)
diff --git a/README.md b/README.md
index 0d398d6..bcb09e3 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,88 @@
-# Centralized platform for all the colleges to access their study material
+
+
+
+
75percent
+
+
+Table of Contents
+
+- [Overview of project](#overview-of-project)
+- [Features](#features)
+- [Tech Stack](#tech-stack)
+ - [Frontend](#frontend)
+ - [Backend](#backend)
+- [Getting Started](#getting-started)
+- [How to get started with open source?](#how-to-get-started-with-open-source)
+- [Contributing](#contributing)
+ - [How to contribute](#how-to-contribute)
+ - [How to make a pull request](#how-to-make-a-pull-request)
+- [Usage](#usage)
+- [shoots](#shoots)
+- [Home page](#home-page)
+
+# Centralized platform for all the colleges to access their study material
This repository contains the source code for a website designed to help college students access their study materials like quantum books, lectures, notes, past year questions (PYQ), and many more
+## Overview of project
+
+
+At 75% .com, our mission is to make quality education accessible to everyone. We understand the challenges students face in navigating their academic journey, and we're here to support you every step of the way with clear, concise, and reliable study materials. What We Offer Tutorials: Step-by-step tutorials covering a wide range of subjects and topics. Our tutorials are crafted by experienced educators to help you grasp complex concepts easily. Notes: Well-organized and detailed notes that highlight key points and essential information. Perfect for quick reviews and in-depth study sessions. Syllabus Guides: Stay on top of your curriculum with our up-to-date syllabus guides. We provide comprehensive outlines to ensure you’re prepared for every exam and assignment. Study Resources: Access a wealth of additional resources, including practice tests, revision tips, and study planners to optimize your learning experience. Why Choose 75% .com? Quality Content: Our materials are meticulously curated by subject matter experts to ensure accuracy and relevance. User-Friendly: An intuitive and easy-to-navigate website that allows you to find what you need quickly and efficiently. Accessible Anytime, Anywhere: Whether you’re studying from home or on the go, our resources are available 24/7 to fit your schedule. Community Support: Join a vibrant community of learners where you can share insights, ask questions, and collaborate with peers. Join Us Empower your academic journey with 75% .com. Explore our extensive library of educational content and take the first step towards achieving your academic goals. Together, we can make learning an enriching and fulfilling experience.
+
+(back to top)
+
+## Features
+
+
+This website is designed to help college students manage their notes, past-year questions (PYQ), and lectures. It allows users to:
+
+- access quantum books
+- lecture for the year-wise student
+- all year can access the timetable of their class in one place
+- accessing the syllabus for all subject
+- Access a question set of past year questions (PYQ)
+- Manage and keep track of upcoming lectures
+
+(back to top)
+
+## Tech Stack
+
+
+### Frontend
+
+
+ 
+ 
+ 
+ 
+
+
+- **HTML**:HTML (HyperText Markup Language) is a skeleton of a website, structuring content with tags and elements.
+- **CSS**:CSS is a style sheet language used to style web pages.It enables the application of different styles based on media types and user preferences, enhancing user accessibility and readability
+- **JavaScript**:JavaScript is a programming language used to add interactivity to websites.
+- **React.js**:A JavaScript library for building user interfaces. It allows developers to create large web applications that can update and render efficiently in response to data changes.
+
+### Backend
+
+
+
+
+
+
+
+- **MongoDB**: A NoSQL database that provides high performance, high availability, and easy scalability. It stores data in flexible, JSON-like documents.
+- **Express.js**: A minimal and flexible Node.js web application framework that provides a robust set of features for web and mobile applications.
+- **Node.js**: A JavaScript runtime built on Chrome's V8 JavaScript engine, enabling server-side scripting and running scripts server-side to produce dynamic web page content.
+
+(back to top)
+
+
+
## Getting Started
+
To get a local copy up and running, follow these simple steps:
@@ -13,10 +90,97 @@ To get a local copy up and running, follow these simple steps:
2. Navigate into the project directory: `cd Project-Name`
3. Install NPM packages: `npm install`
+## How to get started with open source
+
+
+
+
+You can refer to the following articles on the basics of Git and Github.
+
+- [Watch this video to get started, if you have no clue about open source](https://youtu.be/SYtPC9tHYyQ)
+- [Forking a Repo](https://help.github.com/en/github/getting-started-with-github/fork-a-repo)
+- [Cloning a Repo](https://help.github.com/en/desktop/contributing-to-projects/creating-a-pull-request)
+- [How to create a Pull Request](https://opensource.com/article/19/7/create-pull-request-github)
+- [Getting started with Git and GitHub](https://towardsdatascience.com/getting-started-with-git-and-github-6fcd0f2d4ac6)
+(back to top)
+
+## Contributing
+
+
+### How to Contribute?
+
+
+- Take a look at the existing [Issues](https://github.com/akshitagupta15june/PetMe/issues) or [create a new issue](https://github.com/AbhiDiva96/75per/issues/new)!
+- [Fork the Repo](https://github.com/AbhiDiva96/75per/fork). Then, create a branch for any issue that you are working on. Finally, commit your work.
+- Create a **[Pull Request](https://github.com/AbhiDiva96/75per/compare)** (_PR_), which will be promptly reviewed and given suggestions for improvements by the community.
+- Add screenshots or screen captures to your Pull Request to help us understand the effects of the changes proposed in your PR.
+- **DON'T CREATE PRs WITHOUT CREATING ISSUE AND GETTING ASSIGNED**
+
+(back to top)
+
+### How to make a pull request
+
+
+**1.** Start by making a Fork of the [**75per**](https://github.com/AbhiDiva96/75per) repository. Click on the 
Fork symbol at the top right corner.
+
+**2.** Clone your new fork of the repository in the terminal/CLI on your computer with the following command:
+
+```bash
+git clone https://github.com//75per
+```
+
+**3.** Navigate to the newly created PetMe project directory:
+
+```bash
+cd 75per
+```
+
+**4.** Set upstream command:
+
+```bash
+git remote add upstream https://github.com/AbhiDiva96/75per.git
+```
+**5.** Create a new branch:
+
+```bash
+git checkout -b YourBranchName
+```
+
+**6.** Sync your fork or your local repository with the origin repository:
+
+- In your forked repository, click on "Fetch upstream"
+- Click "Fetch and merge"
+
+**7.** Make your changes to the source code.
+
+**8.** Stage your changes and commit:
+
+⚠️ **Make sure** not to commit `package.json` or `package-lock.json` file
+
+⚠️ **Make sure** not to run the commands `git add .` or `git add *`. Instead, stage your changes for each file/folder
+
+```bash
+git add public
+```
+
+```bash
+git commit -m ""
+```
+
+**9.** Push your local commits to the remote repository:
+
+```bash
+git push origin YourBranchName
+```
+
+**10.** Create a pull request!
+
+**11.** **Congratulations!** You've made your first contribution!!
## Usage
+
After installing the dependencies, you can start the local server:
@@ -26,25 +190,24 @@ npm run start
```
Navigate to `http://localhost:3000` in your web browser to view the application.
+(back to top)
## shoots
+
+(back to top)
## Home page
+
+(back to top)
-## Features
-This website is designed to help college students manage their notes, past-year questions (PYQ), and lectures. It allows users to:
+Feel free to contribute to this project by opening issues or submitting pull requests!
-- access quantum books
-- lecture for the year-wise student
-- all year can access the timetable of their class in one place
-- accessing the syllabus for all subject
-- Access a question set of past year questions (PYQ)
-- Manage and keep track of upcoming lectures
+Thank you for your invaluable contributions to our project!
-Feel free to contribute to this project by opening issues or submitting pull requests!
+(back to top)