GDSC JGEC Website

Table of Contents

1. About The Project
   • Built With
   • File Structure
   • Before You Start
2. Getting Started
3. Roadmap
4. License
5. Contact

About The Project

This is the first time we have GDSC in JGEC. Hence we will be building our official website to showcase all that awesome stuff that GDSC will be doing in future. This is a beginner friendly project and we hope to build an amazing website from scratch.

Built With

The tech stack we will be using:

• HTML
• CSS
• JavaScript
• Bootstrap

File Structure

  ├── assets/
        ├──img/               contains all images (don't use caps or space in file name).
        ├──ui/                contains ui's.
        ├──logo(png,svg)      contains the logo in (png,svg).
        ├──opengraph
  ├── css/
        ├──settings.css       all the default styling settings.
        ├──(all css files)    all other css files for pages.
  ├── js/
        ├──script.js          all the scripts/functions for website.
  ├── pages/
        ├──(all pages)        all pages of website.
  ├── index.html              main page of the website.

Before You Start

• Always maintain the file format & folder structure.
• Maintain proper file names (i.e, for images).
• Don't use capital or spaces for files names instead use _ or -.

---

Getting Started

Below are the steps to follow to contribute to this project:

1. Fork this repository.

2. Clone your forked copy of the project.

git clone https://github.com/<your_user_name>/gdscjgec.github.io.git

where your_user_name is your GitHub username.

3. Navigate to the project directory 📁 .

cd gdscjgec.github.io

4. Add a reference(remote) to the original repository.

git remote add upstream https://github.com/gdscjgec/gdscjgec.github.io.git

5. Check the remotes for this repository.

git remote -v

6. Always take a pull from the upstream repository to your main branch to keep it at par with the main project(updated repository).

git pull upstream main

7. Create a new branch.

git checkout -b <your_branch_name>

8. Make necessary changes and commit those changes

9. Track your changes.

git add .

10. Commit your changes .

git commit -m "Commit message"

11. Push the committed changes in your feature branch to your remote repo.

git push -u origin <your_branch_name>

12. To create a pull request, click on compare and pull requests. Please ensure you compare your feature branch to the desired branch of the repo you are suppose to make a PR to.

13. Add appropriate title and description to your pull request explaining your changes and efforts done.

14. Click on Create Pull Request.

15. And you are done creating a pull request to this project. Be patient while we review your code and merge the changes.

Roadmap

See the open issues for a list of proposed features (and known issues).

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Mail us at - [email protected]