-
Notifications
You must be signed in to change notification settings - Fork 173
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
63c5ff4
commit 7c92250
Showing
1 changed file
with
51 additions
and
0 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 |
---|---|---|
@@ -0,0 +1,51 @@ | ||
# Amupedia | ||
Visit our website [Amupedia]https://www.amupedia.com/ | ||
|
||
## Table of Contents | ||
- Introduction | ||
- Features | ||
- Getting Started | ||
- Contribuitng Guidelines | ||
- Code of Conduct | ||
|
||
## Introduction | ||
Amupedia is the biggest platform to help fellow students through their college program. This initiative will cater to the academic demands of the students and give assistance to them in every way possible. Everyone out there is running in the race to the top, and we here offer a push to anyone who needs it. Whether you come for the notes, read our blogs, or attend our events, you will emerge from Amupedia with new knowledge, perspective, influences, and connections. | ||
|
||
## Features | ||
- Providing you with all the quality stuff related to B.Tech, B.Com, B.E, and various other courses. | ||
- The pdfs related to experiment, viva, quizzes question, the mid and end semester examination as well as the assignments. | ||
- We are providing all this content for free. | ||
|
||
## Getting Started | ||
1). Fork the repository (Click the Fork button in the top right of this page, click your Profile Image) | ||
2). Clone the forked repository to your local machine. | ||
3). Make your branch from test branch. | ||
``` | ||
git clone https://github.com/your-username/Project-Amupedia.git | ||
``` | ||
4). Change the present working directory | ||
``` | ||
cd Project-Amupedia | ||
``` | ||
5).Make your changes | ||
``` | ||
git add . | ||
git commit -m "Your commit Message" | ||
git push origin branch-name | ||
``` | ||
6). Make a pull request. | ||
- Star the repository. | ||
|
||
#### Building Amupedia | ||
- Install npm from browser(windows), using sudo apt install npm(linux) in the terminal | ||
- In the root directory: npm install for downloading all the dependencies needed for the project | ||
- Run npm run build for building the project | ||
- Run npm run dev This will start the server on localhost:3000 | ||
|
||
## Contribuitng Guidelines | ||
For the enthusiasts who want to contribute to CodeHarbourHub, please refer to our [Contributing Guidelines]https://github.com/amupedia2021/amupedia-web/blob/develop/CONTRIBUTING.md | ||
|
||
## Code of Conduct | ||
For all the enthusiastic contributers, please refer to the [Code of Conduct]https://github.com/amupedia2021/amupedia-web?tab=coc-ov-file | ||
|
||
Happy Coding!! |