sac-kgec-web

Students' Automobile Club, KGEC

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

To be updated after today's meet

Getting started

Everyone is welcomed to contribute to our project. Mentioning in bold, you do not need to know the tech stack and tools beforehand to be a part of our project. This is a learn-and-build projects where the contributors build alongside learning the various concepts and technologies involved. Below are a few prerequisites and installation guides:

Prerequisites

• Go - download
• A web browser

Installing

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

1. Fork and clone the repository followed by opening the project in your text editor (with a terminal)
2. create a .env file and add this line PORT=5000
3. That was all for setting up the project. Whenever you need to run the project, type go run main.go in the terminal

Live demo

Built with

• Golang (with Gin-Gonic)
• HTML, CSS, JS

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