itsSnehaM / sac-kgec-web

Revamped website of Students' Automobile Club, KGEC built using simple HTML, CSS, JS and rendered on the server side using Golang

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Students' Automobile Club, KGEC

Contributors Forks Issues Pull Request

A basic GitHub repository template for initializing open source projects on a single click.

Contents

  1. Description
  2. Project structure
  3. Project roadmap
  4. Getting started
  5. Live demo
  6. Built with
  7. Contributing
  8. Authors
  9. License
  10. Acknowledgments

Description

This project hosts the revamped version of SAC KGEC's official website

Project structure

/
  ├── .github/            github related files like PR templates, contribution guidelines
  ├── client/             client side code            
      ├── css/            stores all the css files
      ├── img/            directory for images used in frontend
      ├── js/             directory for frontend javascript           
      ├── blogs.json      stores individual blogs as json
      ├── *.html          all HTML files go here
  ├── server/             server side code
      ├── blogs.go        extracts blogs from the blogs.json from client side
      ├── controller.go   handler functions for routes go here
      ├── routes.go       endpoint definitions go here
      ├── server.go       initiates the routes and the gin-gonic server
  ├── .gitignore          stores files and directories to be ignored in commits
  ├── go.mod              stores definitions of go packages and modules used
  ├── go.sum              stores definitions of go packages and modules used
  ├── LICENSE             the open source license
  ├── main.go             entry point to the server
  └── readme.md           project readme!

Project roadmap

TODO: to be updated The project currently does the following things.

  • Feature 1
  • Feature 2
  • Feature 3

See below for our future steps.

  • Feature 1
  • Feature 2
  • Feature 3

Getting started

Prerequisites

Installing

A step by step series of examples that tell you how to get a development env running.

Live demo

Built with

Contributing

Please read contributing.md for details on our code of conduct, and the process for submitting pull requests to us.

Authors

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

About

Revamped website of Students' Automobile Club, KGEC built using simple HTML, CSS, JS and rendered on the server side using Golang

License:MIT License


Languages

Language:Go 97.7%Language:HTML 2.3%