Skip to content

Commit 86a2694

Browse files
committed
Fixed README
1 parent 0b3480d commit 86a2694

File tree

2 files changed

+11
-8
lines changed

2 files changed

+11
-8
lines changed

README.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
# FOSS Clubs GEC Palakkad Official Website
1+
# FOSS Club GEC Palakkad: Official Website
2+
3+
<p align="center">
4+
<img src="docs/website-hero.webp" width="700" height="auto" title="Hero Page of the Website">
5+
</p>
26

37
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.
48

@@ -17,13 +21,13 @@ To get a local copy of the project up and running, follow these steps:
1721
1. Clone the repository:
1822

1923
```
20-
git clone https://github.com/foss-clubs-gec-palakkad/website.git
24+
git clone https://github.com/FOSS-Cell-GECPKD/Website.git
2125
```
2226

2327
2. Navigate to the project directory:
2428

2529
```
26-
cd website
30+
cd Website
2731
```
2832

2933
3. Install dependencies:
@@ -35,10 +39,10 @@ To get a local copy of the project up and running, follow these steps:
3539
4. Start the development server:
3640

3741
```
38-
npm run serve
42+
npm run dev
3943
```
4044

41-
The website should now be running at `http://localhost:8080`.
45+
The website should now be running at `http://localhost:5173/`.
4246

4347
## Contributing
4448

@@ -66,17 +70,16 @@ Please refer to the [Contribution Guide](CONTRIBUTING.md) for more detailed inst
6670

6771
To maintain a consistent and high-quality codebase, we follow these best practices:
6872

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.
7074
- **Components**: Modularize the UI into reusable Vue components.
7175
- **State Management**: Use Vuex for managing the application state, if necessary.
7276
- **Responsive Design**: Ensure the website is responsive and accessible across different devices and screen sizes.
7377
- **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.
7578

7679
## Code of Conduct
7780

7881
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).
7982

8083
## License
8184

82-
This project is licensed under the [MIT License](LICENSE).
85+
This project is licensed under the [MIT License](LICENSE).

docs/website-hero.webp

27.4 KB
Loading

0 commit comments

Comments
 (0)