Skip to content

Latest commit

 

History

History
99 lines (73 loc) · 2.78 KB

readMe.md

File metadata and controls

99 lines (73 loc) · 2.78 KB
Raw

PClub Website

Programming Club website with User and Admin frontend

Introduction • Key-Feature • Requirements • Installation

Introduction

PClub website is a project developed with NodeJs framework and vanilla CSS to implement a user-friendly interface including user and admin front end and database connectivity.

Key-Feature

  • Vanilla CSS ⟶ Easier to maintain and update. Lightweight code.
  • Filepond ⟶ User friendly file drag and drop system with preview.
  • MongoDB ⟶ Faster than sql database to reduce the execution time.
  • Carousel ⟶ Slideshow for poster and images.
  • Email Subscription ⟶ Get user a chance to connect with PCLub in order to receive updates.
  • Responsive Template ⟶ Compatible for multiple types of device(Mobile, Laptop, Desktop, Tablet).

Requirements

  • Node Js version v12.18.0 or higher. See here for install instructions.
  • NPM version 6.14.4 or higher. See here for install instructions.

Installation

From our Latest Release

  • Download our latest release from the Releases section.
  • Unzip the downloaded zip file.

Building the source code

  • Clone the repository
git clone https://github.com/mrparth23/PClub-Website.git
cd PClub

Generate modules for project

  • Build all the modules from package.json. npm is our build system.
npm install --save

Get it done & Running

  • If you want to use project as "Production"
npm run start
  • If you want to use project as "Development"
npm run dev