Skip to content

Latest commit

 

History

History
132 lines (87 loc) · 4.55 KB

README.md

File metadata and controls

132 lines (87 loc) · 4.55 KB
Raw

Untitled design

https://acadmica.social

Acadmica

Acadmica is running with the aim of becoming India's largest student community, where students can help each other by sharing notes among themselves. We are engineering student ourselves; thus we are well aware of the problems faced by students in their college life. Be it college academics, development (personal or professional), programming or coding, internships, placement preparation, techfests and events, cultural clubs and whatnot?!

Worry not! We provide subjectwise notes, subjectwise study material; various coding questions and DSA sheets for placements, developer roadmaps for almost everything -- all in one place. We go through the internet to find the best resources to serve you. Any contribution is also welcome if you feel your content (notes/study materials) can help others, he/she can send the material to us, you will be given credits for your work ofcourse in all the social media handles of @cadmica!

Project Structure

Folder Structure Explained

This is a multipage-website. You can click on various pages at the navbar to go to the desired page.

  • public This folder contains an HTML page called index.html which also happens to be the homepage of the site.

    Page Name Folder Description
    index.html This page contains all the HTML code of Acadmica web portal

  • src

    Folder Name Folder Description
    CSS It contains one folder named as component-css and one CSS file named as index.css
    JS JavaScript Folder
    Assets This folder contains all the images used in site.

  • component-css

    File Name File Description
    about.css It contains CSS code of About Acadmica part
    footer.css It contains CSS code of footer part
    main.css It contains CSS code of main hero page part of Acadmica
    navbar.css It contains CSS code of navbar of Acadmica

  • index.css : This file contains CSS code of base CSS file and it also connects all the CSS files inside it.

Setup & Contribution Guidelines:

  1. Fork the repository

    Click on Fork button present on the upper-right area of the screen to create a copy of this repository to your GitHub account.

  2. Clone the repository

git clone https://github.com/<YOUR_USERNAME>/Acadmica.git
  1. Navigate to Acadmica repo directory
 cd Acadmica
  1. Add a reference to the original repository as upstream
git remote add upstream https://github.com/tier3guy/Acadmica.git
  1. Verify the remotes for this repository
git remote -v
  • Output of above commands should be the same as: 
    origin   https://github.com/<YOUR_USERNAME>/Acadmica.git (fetch)
origin   https://github.com/<YOUR_USERNAME>/Acadmica.git (push)
upstream https://github.com/Acadmica/Acadmica.git (fetch)
upstream https://github.com/Acadmica/Acadmica.git (push)

  1. Update Fork Repo From Upstream (to remain updated with the orignal repo)

  2. Update your local branch to be in-sync with the original repo

  git pull upstream master

Contribution guide

  1. Create a new branch
git checkout -b <your_branch_name>
  1. Perform your desired changes to the code base in your forked repo
  2. Track your changes heavy_check_mark: .
git add .
  1. Commit your changes
git commit -m "Relevant message"
  1. Push the committed changes in your feature branch to your remote repo
git push -u origin <your_branch_name>

  1. To create a pull request, click on compare and pull requests button

  2. Please ensure that you compare your feature branch to the desired branch master of the repo to make a PR

  3. Add an appropriate title and relevant description to your pull request explaining your changes and efforts done

  4. Make sure to edit the PR template

  5. Click on Create Pull Request.

A big thanks to our valuable contributors! It would not have been possible without each of you!