Skip to content

Arakasi21/university-clubs-frontend

Repository files navigation


Logo

AITU UCMS Frontend

This is the frontend part of the University Clubs Management System (UCMS) at AITU.

Table of Contents
  1. About The Project
  2. Backend Microservices
  3. Protofiles
  4. Technologies Used
  5. Getting Started
  6. Running the Service
  7. Deploy on Vercel

About The Project

This is the frontend part of the University Clubs Management System (UCMS) at AITU. The UCMS is a system that allows students to create and join clubs, create and attend events, and communicate with other students. The UCMS is a distributed system that consists of several microservices. This repository contains the frontend part of the UCMS.

(back to top)

Backend Microservices

(back to top)

Technologies Used

  • Next.js
  • React
  • TypeScript
  • Zustand
  • Shadcn
  • Tailwind
  • Vercel

(back to top)

Getting Started

Prerequisites

  • npm or yarn
  • Node.js
  • backend services running

Installation

  1. Clone the repository:

    git clone https://github.com/Arakasi21/university-clubs-frontend.git
    cd university-clubs-frontend
    npm install

(back to top)

Configuration

The configuration is done using environment variables. The following environment variables are required:

Create .env file:

touch .env

Example Configuration Snippet

NEXT_PUBLIC_API_URL=http://localhost:3000
NEXT_PUBLIC_BACKEND_URL=http://localhost:5000

(back to top)

Running the Service

First, run the development server:

npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev

Open http://localhost:3000 with your browser to see the result.

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.

Releases

No releases published

Packages

No packages published

Languages