Skip to content

Latest commit

 

History

History
102 lines (66 loc) · 2.02 KB

README.md

File metadata and controls

102 lines (66 loc) · 2.02 KB
Raw

CMS

Club Management System is a web application that helps clubs manage their day-to-day operations more efficiently and effectively. It typically includes features such as: Membership management, Event management, Communication tools, Reporting and analytics

Build with

Frontend

  • React
  • Tailwind
  • React router dom
  • parcel (bundler)

How to setup and run frontend locally

Prerequisites

NodeJs should be installed in your system.

Steps to setup

  1. First clone the repo

    git clone https://github.com/gdsc-gvp/CMS.git
    cd CMS/frontend

  2. Install all the dependencies

    npm install

  3. Run the frontend

    npm start

Backend

How to setup and run backend locally

Prerequisites

Before you begin, ensure you have the following software installed on your computer:

Installation

Steps to setup

Follow these steps to set up the CMS backend on your local machine:

  1. Fork the Repository:

    First, fork the repository by clicking the "Fork" button at the top right of the GitHub page.

  2. Clone the Forked Repository:

    Clone your forked repository to your local machine using the following command (replace <your_github_username> with your GitHub username):

    git clone https://github.com/<your_github_username>/CMS.git

  3. Change directory

    cd CMS/backend

  4. Set the 'upstream' remote repository to track changes from the original repository

    git remote add upstream https://github.com/gdsc-gvp/CMS.git

  5. Pull the latest changes from the 'upstream' remote's 'dev' branch into your local branch

    git pull upstream main

  6. Create a new branch for the task you were assigned to, eg (Feat/Bug/Fix/Chore) :

    git checkout -b <your_branch_name>

eg- git checkout firsthack

Running Locally

npm install

npm run start