Skip to content

cloudflips32/se-club

Repository files navigation

Next React Sass TailwindCSS Firebase


Documentation

Overview

SE Club is a community space for students and enthusiasts to collaborate on Software Engineering topics. This repository contains the Software Engineering club website. It was created with the intention of helping individuals collaborate and grow to better meet the requirements to find a software engineering role.

Features

  • Community: Encourages open-source contributions and collaboration among students and software engineers.
  • Internship Opportunies: A collection of resources useful for students seeking internship roles.
  • Club Events: Meeting times and subjects of interest listed.

Installation

To get started with the SE Club repository, follow these steps to install and set up the necessary tools on your local machine.

Prerequisites

Make sure you have the following installed on your system:

  • Git: Download Git
  • A suitable programming language runtime (e.g., Python, Java, Node.js depending on the tools included in the repository)

Clone the repository

git clone https://github.com/cloudflips32/se-club.git
cd se-club

Install Dependencies

Within terminal:

npm install
npm init
npx npx create-next-app@latest
npx shadcn@latest init
npx shadcn@latest add accordion dialog icons label toast
npm install -D tailwindcss postcss autoprefixer sass
npx tailwindcss init
npm install firebase @firebase/irestore git @next/env bcrypt dotenv uuid
git init

Running the Project Follow the specific instructions provided in the individual project directories (e.g., README.md) for running different tools or applications that are part of the SE Club.

npm run dev

Collaboration:

Engage with the community by participating in discussions, opening issues, and reviewing pull requests.

Contributing:

We welcome contributions from everyone. Whether you're fixing a bug, adding a new feature, or updating documentation, your help is appreciated.

To contribute, please:

  • Fork this repository.
  • Create a new branch for your changes.
  • Make your changes, and be sure to test them thoroughly.
  • Commit your changes with clear messages describing what you did.
  • Push your changes to your forked repository.
  • Open a pull request to the main branch of this repository.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Support

If you encounter any issues or need help, feel free to open an issue in the repository or reach out to the community via the discussions page.

Acknowledgments

Thanks to the Software Engineering club for continuous collaboration and support. Click Here!

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •