Code Monkey home page Code Monkey logo

sac-kgec-web's Introduction

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

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

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

sac-kgec-web's People

Contributors

singhayushh avatar kylixmedusa avatar sudip-101 avatar arnab-batsy avatar sorba160 avatar anilphiyak617 avatar mangalam0512 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.