Skip to content

Latest commit

 

History

History
46 lines (38 loc) · 3.24 KB

README.md

File metadata and controls

46 lines (38 loc) · 3.24 KB
Raw

Introduction:

Website for openhack hackathon. (yet prototype)

P.S: If the logo isn't displaying correctly -- who uses light theme yaar? go change your theme first.

Installation

run npm install from root.

latest version of React can cause some issues with react-scroll (at least, it did for me). if you face any issues, clean npm cache. and make sure that installed react version is 16.10. if it still doesn't solve your problem, you know Stack Overflow is the way to go; or feel free create an issue here.

Build and Deployment

npm run build Serve -s build

you'll need serve to be globally installed.

Overview and Project Structure:

Ignoring all the typical boilerplate stuff, the src is the main folder. which includes components, images and pages directory. pages contain index.js, which exports the one and only home page of the site.images contain SVGs used in page, being the logo and the one used in about section of the page.

components contains a folder per every section of the website, being HeroSection, About, Schedule, Problem Statements etc. numbered so we don't have to find them every time trying to change them. (alphabetical sort can be pain in the * sometimes) and separate folders for navigation bar, side bar, logo, card and cardlist components. CardList and Card components are used to display the cards of team and judges section. These all components are imported in pages/index.js file.

ButtonElements.js and Commons.js files include css for button and common css elements such as Container and Wrapper. The actual component inside every folder lies within index.js file. there could be an extra file with componentElements.js, it doesn't bite. It contains css specifically used for that component only. Schedule component contains the Timeline.js file, which exports the timeline used in schedule section of the webpage. don't you ever get tired of reading? shoo have some life.

Todo:

  • add social media icons for profile card
  • add appropriate data inplace of lorem ipsum.
  • add working social media links
  • add problem statements, prizes, sponsors, judges and FAQ.
  • populate teams with some real data.
  • Update favicon icon and document title
  • drink some water

Live: https://iei-openhack.herokuapp.com/

Suggestions? Want to contribute? Pull requests are always open.

  • Fork it
  • Clone it to your local system
  • Make a new branch
  • Make your changes
  • Push it back to your repo
  • Click the Compare & pull request button
  • Click Create pull request to open a new pull request

Have a nice day :)