This repository contains the source code for the official website of the FOSS Clubs (Free and Open Source Software Clubs) at Government Engineering College, Palakkad. The website is built using Vue.js, a progressive JavaScript framework for building user interfaces.
To get a local copy of the project up and running, follow these steps:
-
Clone the repository:
git clone https://github.com/foss-clubs-gec-palakkad/website.git -
Navigate to the project directory:
cd website -
Install dependencies:
npm install -
Start the development server:
npm run serveThe website should now be running at
http://localhost:8080.
We welcome contributions from the community! If you'd like to contribute to this project, please follow these steps:
-
Fork the repository.
-
Create a new branch for your feature or bug fix:
git checkout -b my-new-feature -
Make your changes and commit them with descriptive commit messages.
-
Push your changes to your forked repository:
git push origin my-new-feature -
Create a new pull request against the
mainbranch of the original repository.
Please refer to the Contribution Guide for more detailed instructions.
To maintain a consistent and high-quality codebase, we follow these best practices:
- Coding Style: Follow the Vue.js Style Guide for consistent code formatting and naming conventions.
- Components: Modularize the UI into reusable Vue components.
- State Management: Use Vuex for managing the application state, if necessary.
- Responsive Design: Ensure the website is responsive and accessible across different devices and screen sizes.
- Performance Optimization: Optimize the website for better performance by following best practices like code splitting, lazy loading, and minification.
- Testing: Write unit tests and end-to-end tests to ensure code quality and functionality.
We have adopted a Code of Conduct to ensure a welcoming and inclusive environment for all contributors. Please read and follow the Code of Conduct.
This project is licensed under the MIT License.