Apsara2.0

Second version of iit-techambit frontend.

Set up:

Installation

npm install

Running on localhost

npm start

NOTE: Please use only npm as package manager not any other to avoid dependency clashes

To Contribute

We do not commit to master branch directly. We open pull requests and merge them in master after review.
Create the issue as necessary.
If you lack the technical knowhow, feel free ask in the slack workspace.
Create a Branch and Commit your changes.
- Name the branch carefully. For example feature-card-component, bugfix-overlay. Do not use generic names such as develop, work, your username etc.
- Name the commits meaningfully. For help read How to Write a Git Commit Message.
Check if the solution works by testing it locally.
Submit a PR with an appropriate name including the term Fixes #{issue number} if it fixes that particular issue.
Be attentive and respond to comments and suggestions in the opened PR.
We will merge your PR after reviewing and testing it.

While contributing

Use prettier extension for code linting

Deployment

Note that the master branch is deployed to server through Midgard. Any commits pushed to master will be deployed to server instantly

A manual deployment can be triggered by going to the midgard dashboard.

Documentation

The documentation for the Material Kit React is hosted at our website.

Configuration - Settings.json in VS Code

{
  "files.trimTrailingWhitespace": true,
  "editor.formatOnSave": true,
  "eslint.autoFixOnSave": true,
  "eslint.alwaysShowStatus": true,
  "javascript.updateImportsOnFileMove.enabled": "always",
  "prettier.jsxSingleQuote": true,
  "prettier.singleQuote": true
}

Use Pascal case naming convention for naming files, variables meaningfully.
Usage of ES6 Features when compared to vanilla JS is highly recommended.

Docs - Easy reference to make changes for devs

Routes

All the routes are present in src/index.js

Navbar

Navbar is present in src/views/Components/Navbar.js
And navbar items are present in src/components/Header/HeaderLinks.js

Landing Page

The frontpage is present in src/views/Components/Components.js

Stories

/stories route
The component that is rendered in the page is src/views/Archive/Archive.js which renders Article cards.Here only data is being fetched from the Drupal CMS API
Each Article card is present is present in src/views/Archive/ArticleCard.js
On clicking on each card, leads to ReadingPage of each article which is the component src/views/ReadingPage/ReadingPage.js,Here also the data is fetched from Drupal CMS API

Team Page

/team route
The component that is being rendered is in src/views/Team/Team.js which displays TeamMemberCard. Each team members details are present in the array named TeamList in src/views/Team/TeamList.js
The team member card is present in src/views/TeamMemberCard.js

Stylings

For stylings we are using SASS, Don't worry, just write plain CSS in the scss file too. It works perfectly fine
Mostly, we have tried naming to be in such a way that the name of the .js file and .scss file match. Keep up the practice please !

Licensing

Licensed under MIT (https://github.com/creativetimofficial/material-kit/blob/master/LICENSE.md)

iit-technology-ambit / Apsara2.0

readme