search

suraj-fusion / Solarify-India

0 stars 1 forks source link
beginner-friendly beginner-project css hackodex-iter hackodex2023 html js

readme

Solarify-India

This project is especially made to teach people how to do open source contributions under the event called hackodex organised by codexclub of ITER Bhubaneshwar please make sure you have registered on https://hackodex.codex-iter.in/ before contributing.

Tech Stacks Used : HTML | CSS | JAVASCRIPT | NODE JS | EXPRESS | EJS

A fullstack website that aims to spread awareness in India about solar energy in a neat and simplified manner to attract potential solar energy users.

Getting Started

  1. Make sure you have a GitHub Account.
  2. Make sure VS code is installed on your system.
  3. Make sure you have Git installed on your system.
  4. Fork the repository on GitHub.
  5. Make sure node.js is installed on your system.It can be installed from : https://nodejs.org/en/

Simple step by step instructions to contribute to this repo

  1. Fork this repo
  2. Go to any directory you want to download this project to
  3. run the command git init
  4. then clone this repository on your local system by running the command git clone "your forked repo url" Since the node modules are included it will take some time to get cloned so wait a little
  5. Make sure node.js is installed on your system.It can be installed from : https://nodejs.org/en/
  6. Run the app on your local system by using the command nodemon index.js I have included the nodemodules needed to run this app in the repo itself so it can be run directly so that you dont have to worry about setting up visit http://localhost:3000 in order to access this webapp
  7. Make appropriate changes
  8. Now run the command git add .
  9. Now commit your changes with a valid message using the command git commit -m "your valid message"
  10. Then push the changes you have made by running the command git push -u origin master
  11. then come back to github and create a pull request and wait for it to be merged