UOK CS 5th Batch Website

Welcome to the official portal of the 5th Batch of Computer Science Students at the University of Kelaniya! 🎓

This website serves as a platform for showcasing the details, profiles, and projects of our batch.

🚀 Features

• Student Profiles: Each student can add their personal details to the website.
• Projects: Showcase your individual or group projects.
• Event Updates: Stay updated with the latest events and announcements.
• Open-Source Contributions: See how we contribute to the open-source community.

🌱 Get Started

To get started with this project locally, follow the steps below:

1. Clone the repository

Clone this repository to your local machine:

git clone https://github.com/UOK-CS-Batch5/batch5.git

2. Install dependencies

Navigate to the project directory and install dependencies:

cd batch5
npm install

3. Run the development server

Start the development server:

npm run dev

Open your browser and visit http://localhost:3000 to view the site locally.

🛠️ Technologies Used

• Next.js for building the website.
• MDX for content management and documentation.
• Tailwind CSS for styling.
• GitHub Pages for deployment.

📚 How to Contribute

We welcome contributions from everyone! Whether you're adding your own profile, fixing bugs, or improving the documentation, follow the steps below:

1. Fork the repository.
2. Create a folder in the pages/Meet_our_team directory with your name (no spaces).
3. Add your details in the form of MDX files (about.mdx, me.mdx, etc.) and a _meta.js file.
4. Run npm test to validate your changes.
5. Submit a pull request.

For detailed instructions, see the Contribution Guidelines.

🐛 Reporting Issues

If you encounter any issues with the website or have any suggestions, please open an issue in the Issues tab of this repository.

📬 Contact

Feel free to reach out to the batch for any inquiries or updates:

• Email: Email
• GitHub: UOK-CS-Batch5

---

License
This project is licensed under the MIT License.

---

Thank you for visiting and contributing to the UOK CS 5th Batch website! Let’s make it awesome together! 😄

---

Key Details:

• CONTRIBUTING.md: Provides clear instructions for contributors to follow, including folder structure, naming conventions, and how to run tests (npm test) before submitting a pull request.

• README.md: Introduces the project, explains its features, and provides installation and contribution guidelines. It also includes information on how to report issues and contact the team.

---

Next Steps:

1. Communicate clearly in the Pull Request description about the changes made, following the structure mentioned in the Contributing Guidelines.

2. Discussions page for collaboration, asking for help, or proposing new ideas. This will help you to communicate and collaborate more easily.