Student Club Web

Student Club Web is an open-source website template that enables student clubs to easily create and manage their digital presence. Although it was initially developed for the Istanbul University Computer Science Club (IU CSC), the project is designed to be flexible and customizable, making it suitable for all university clubs. The platform aims to encourage student participation in club activities, provide an efficient way to share announcements, and enhance the club's digital identity with a modern solution.

---

Table of Contents

• Directory Structure
• Features
• Technologies Used
• Getting Started
  • Installation
    • Using Docker
    • Manual Installation
  • Development Server
  • Production Deployment
    • Building the Project
    • Starting the Production Server
    • Demo
• Contributing
• License

---

Directory Structure

Directory structure:
└── enesbuyuk-student-club-web/
    ├── README.md
    ├── default.env
    ├── docker-compose.yml
    ├── LICENSE
    ├── backend/
    │   ├── Dockerfile
    │   ├── go.mod
    │   ├── go.sum
    │   ├── main.go
    │   └── pkg/
    │       ├── config/
    │       │   ├── database.go
    │       │   ├── environment.go
    │       │   └── jwt.go
    │       ├── handlers/
    │       │   ├── announcements.go
    │       │   ├── auth.go
    │       │   ├── events.go
    │       │   └── useful_links.go
    │       ├── middleware/
    │       │   └── jwt.go
    │       ├── models/
    │       │   ├── announcement.go
    │       │   ├── event.go
    │       │   ├── useful_links.go
    │       │   └── user.go
    │       ├── routes/
    │       │   ├── announcements.go
    │       │   ├── auth.go
    │       │   ├── events.go
    │       │   └── useful_links.go
    │       ├── server/
    │       │   ├── setup_middleware.go
    │       │   ├── setup_routes.go
    │       │   └── setup_server.go
    │       └── services/
    │           └── hashCompare.go
    ├── docs/
    │   ├── examples/
    │   │   └── db/
    │   │       └── university-student-club.announcements.json
    │   └── images/
    └── frontend/
        ├── Dockerfile
        ├── next.config.ts
        ├── package.json
        ├── pnpm-lock.yaml
        ├── pnpm-workspace.yaml
        ├── postcss.config.mjs
        ├── tailwind.config.ts
        ├── tsconfig.json
        ├── .dockerignore
        ├── .eslintrc.json
        ├── messages/
        │   ├── en.json
        │   └── tr.json
        ├── public/
        │   ├── robots.txt
        │   ├── theme/
        │   │   ├── background.webm
        │   │   ├── default-image.webp
        │   │   └── admin/
        │   │       └── admin-login-page.webp
        │   └── uploads/
        │       └── .gitkeep
        └── src/
            ├── middleware.ts
            ├── app/
            │   ├── globals.css
            │   ├── layout.tsx
            │   ├── page.tsx
            │   └── [locale]/
            │       ├── layout.tsx
            │       ├── not-found.tsx
            │       ├── opengraph-image.tsx
            │       ├── page.tsx
            │       ├── [...rest]/
            │       │   └── page.tsx
            │       ├── about/
            │       │   ├── page.tsx
            │       │   ├── charter/
            │       │   │   └── page.tsx
            │       │   └── team/
            │       │       └── page.tsx
            │       ├── admin/
            │       │   ├── (account)/
            │       │   │   ├── sign-in/
            │       │   │   │   └── page.tsx
            │       │   │   └── sign-out/
            │       │   │       └── route.ts
            │       │   └── (dashboard)/
            │       │       ├── layout.tsx
            │       │       ├── page.tsx
            │       │       └── announcements/
            │       │           ├── page.tsx
            │       │           └── [id]/
            │       │               ├── edit/
            │       │               │   └── page.tsx
            │       │               └── remove/
            │       │                   └── page.tsx
            │       ├── announcements/
            │       │   └── page.tsx
            │       ├── contact/
            │       │   └── page.tsx
            │       ├── events/
            │       │   └── page.tsx
            │       ├── faq/
            │       │   └── page.tsx
            │       ├── gallery/
            │       │   └── page.tsx
            │       ├── join-the-club/
            │       │   └── page.tsx
            │       ├── links/
            │       │   └── page.tsx
            │       └── useful-links/
            │           └── page.tsx
            ├── components/
            │   ├── Faq.tsx
            │   ├── Footer.tsx
            │   ├── Gallery.tsx
            │   ├── Header.tsx
            │   ├── HomeTypewriter.tsx
            │   ├── IndexPageSectionLayout.tsx
            │   ├── LanguageSwitcher.tsx
            │   ├── LastEvents.tsx
            │   ├── MediumArticles.tsx
            │   ├── Navbar.tsx
            │   ├── PageLayout.tsx
            │   └── admin/
            │       └── AdminHeader.tsx
            ├── i18n/
            │   ├── request.ts
            │   └── routing.ts
            ├── lib/
            │   ├── metadata.ts
            │   ├── auth/
            │   │   └── auth.ts
            │   └── utils/
            │       └── user.ts
            └── types/
                ├── Admin.ts
                ├── Announcement.ts
                ├── Attempt.ts
                ├── Event.ts
                ├── Post.ts
                └── User.ts

---

Features

• Information about the club
• Membership registration
• News and updates
• Announcements
• Medium articles
• Gallery
• Team page
• Contact form
• Admin Panel

---

Technologies Used

• Next.js: A powerful React framework for building static and server-rendered applications. Next.js optimizes performance, provides automatic code splitting, and enhances SEO, making it the ideal choice for building a fast, scalable website.

• React: A JavaScript library for building user interfaces. React allows the creation of reusable UI components, ensuring that the frontend of the site is dynamic, responsive, and efficient.

• TypeScript: A statically typed superset of JavaScript, TypeScript enhances the development process by adding type safety to the project. This improves code quality and reduces the likelihood of runtime errors.

• Tailwind CSS CSS: A utility-first CSS framework that allows rapid UI development by using pre-defined classes. Tailwind CSS helps maintain a consistent design throughout the website and significantly reduces the amount of custom CSS code needed.

• Go Fiber: A fast and lightweight web framework for building backend services with Go (Golang). Go Fiber is designed to be simple and highly performant, providing a minimalistic API that allows quick routing and efficient handling of HTTP requests. It is especially well-suited for building RESTful APIs and high-performance web applications.

• MongoDB: A flexible and scalable NoSQL database. MongoDB stores data in JSON-like documents and is often used in projects requiring high read/write performance, especially for large datasets.

• pnpm: A fast, disk space-efficient package manager for JavaScript. pnpm ensures faster installation times and better dependency management compared to npm, and it optimizes disk usage by storing dependencies in a global store.

• Docker: A platform for developing, shipping, and running applications in containers. Docker ensures the application runs consistently across different environments, making it easier to deploy and scale the application.

• Traefik: A modern reverse proxy and load balancer. Traefik is used to manage microservices and route traffic between different services. With automatic configuration and dynamic routing features, it makes it easy to manage traffic between services within your application.

---

Getting Started

To get started with the Student Club Web project, follow these steps:

1. Clone the repository

git clone https://github.com/enesbuyuk/student-club-web.git

2. Navigate to the project directory

cd student-club-web

Installation

1. Run the installation script to set up the environment variables

chmod +x setup_env.sh; ./setup_env.sh

This will automatically create the .env file and set the required environment variables.

Using Docker

To run the project using Docker, use the following command:

docker compose up --build

---

Manual Installation

If you prefer to set up the project manually, follow these steps:

1. Clone the repository

git clone https://github.com/enesbuyuk/student-club-web.git

2. Navigate to the project directory

cd student-club-web

3. Install the dependencies

pnpm install

Development Server

To start the development server, use the following command:

pnpm dev

Production Deployment

Building the Project

To build the project for production, use the following command:

pnpm build

Starting the Production Server

To start the production server, use the following command:

pnpm start

---

Demo

Visit the live demo at iucs.net

---

Contributing

Contributions are welcome! Please feel free to submit a pull request.

---

License

This project is licensed under GPL-3.0 License. See the LICENSE file for details.