Code Monkey home page Code Monkey logo

csi-website's Introduction

CSI - Nirma Website

Frontend

  • For now just the client (i.e the frontend has been created)
  • You guys will be working under client folder for the frontend

General Instructions:

  • Under the client folder a src/Pages subfolder is created. All the new pages will be added there.
  • Please DON'T mess with webpack.config.js and .babelrc files, takes an eternity to setup
  • Ignore any warning by webpack not errors.
  • To run the development server run the following command inside the client folder npm run serve More info in package.json
  • All the path to the assets should be absolute starting from "/assets/[whatever]"
  • I have configured react-bootstrap so you can use any prebuilt component it provides.
  • All the samples are available on the sample branch of this repo

Naming Instructions:

  • The name of all pages should be in PascalCase and not in camelCase
  • Variable names should be sensible and should follow camelCase

Guide to components:

  • Each page can have multiple sub-components, so if a page has (Page-Specific) components each of the Page Folder should also have a Components Folder
  • The one who creates a new page is responsible for adding it to the React-Router in the src/App.js.
  • For the components that are reused between multiple pages a global Components folder has been src/Components.

Commiting changes and branching

  • You will commit your changes to the dev branch
  • The main and dev branches will be clean.
  • To check which branch you are working in, type: git branch
  • If you are working on the main branch, then switch to sample branch using the command git checkout sample
  • Now, to add your contirbution in a branch with your name like this: dev_name
  • Use command git checkout -b branch_name to create your branch

Using data

  • The data like events, board member (names and positions), etc should be strictly read from a json file which is directly located in the same folder as the component, i.e the json file and the [Component].js should be under the same folder.
  • There should be no hard coding for these types data, strictly make a state and load this data in that state.

csi-website's People

Contributors

lowlevellore avatar lavanderhoney avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.