This repository is a template for clubs's web pages.
- make sure you have
nodejs,npm,gitinstalled on your machine. - create a repository under your organization under whatever name like
chelix/chelix-nimbus - make sure you have enabled ssh authentication on your personal github account.
- get repository
- clone this repository machine --
git clone [email protected]:pixonoids/club-nimbus.git - remove current remote
git remote remove origin - add your remote
git remote add origin [email protected]:chelix/chelix-nimbus.git
- clone this repository machine --
- set up firebase
- install firebase-tools globally.
npm i -g firebase-tools firebase login- will open web browser - login with club email (gmail) firebase console.- create a project on firebase for this.
firebase init hosting- this will generate a firebase.json file- choose project
- configure for spa
- also setup github auto deploys (CI/CD) - will prompt you to install firebase app on your github organization and after that this will generate
.github/workflows/deploy_to_firebae.yml
- install firebase-tools globally.
- install dependencies
npm install - run project
npm run dev
this is a react project. simple structure just read it you will understand. at any element you can press F12 to go to its definition.
- you can use your own css/scss for components or you can use tailwindcss - install tailwind intelliscence vscode extention for better support.
- Images - you can store images in
public/folder. they will be available with path/Make sure Images Size is not more that 250KB - resize images accordingly, large images may cause longer load times and bad user experience.
- Videos - DO NOT upload videos to repository. Upload your videos to youtube and Embed the youtube video to your page instead.
- 🔥 Git in 100 seconds
- 📚 HTML Elements - just basics
[div,span,h1,p,pre,b,i,img,iframe,...] - 💄 CSS - or you can use Tailwind classes
if you are facing any problems in setting up the environment you can contact the maintainers.