You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+11-8Lines changed: 11 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,8 @@
1
-
# FOSS Clubs GEC Palakkad Official Website
1
+
# FOSS Club GEC Palakkad: Official Website
2
+
3
+
<palign="center">
4
+
<imgsrc="docs/website-hero.webp"width="700"height="auto"title="Hero Page of the Website">
5
+
</p>
2
6
3
7
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.
4
8
@@ -17,13 +21,13 @@ To get a local copy of the project up and running, follow these steps:
@@ -35,10 +39,10 @@ To get a local copy of the project up and running, follow these steps:
35
39
4. Start the development server:
36
40
37
41
```
38
-
npm run serve
42
+
npm run dev
39
43
```
40
44
41
-
The website should now be running at `http://localhost:8080`.
45
+
The website should now be running at `http://localhost:5173/`.
42
46
43
47
## Contributing
44
48
@@ -66,17 +70,16 @@ Please refer to the [Contribution Guide](CONTRIBUTING.md) for more detailed inst
66
70
67
71
To maintain a consistent and high-quality codebase, we follow these best practices:
68
72
69
-
-**Coding Style**: Follow the [Vue.js Style Guide](https://vuejs.org/v2/style-guide/) for consistent code formatting and naming conventions.
73
+
-**Coding Style**: Follow the Vue.js Style Guide for consistent code formatting and naming conventions.
70
74
-**Components**: Modularize the UI into reusable Vue components.
71
75
-**State Management**: Use Vuex for managing the application state, if necessary.
72
76
-**Responsive Design**: Ensure the website is responsive and accessible across different devices and screen sizes.
73
77
-**Performance Optimization**: Optimize the website for better performance by following best practices like code splitting, lazy loading, and minification.
74
-
-**Testing**: Write unit tests and end-to-end tests to ensure code quality and functionality.
75
78
76
79
## Code of Conduct
77
80
78
81
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](CODE_OF_CONDUCT.md).
79
82
80
83
## License
81
84
82
-
This project is licensed under the [MIT License](LICENSE).
85
+
This project is licensed under the [MIT License](LICENSE).
0 commit comments