website-www's Introduction

Website

Welcome to Real Dev Squad

Code deployed on: https://realdevsquad.netlify.app/, then served to our domain

Running the project

Run npm install after opening the repository in your editor. This will install all the necessary packages for the project which are mentioned in the pacakage.json file of the project.

API Calls

For making API Calls of Real Dev Squad, do follow this doc. https://github.com/Real-Dev-Squad/docs/tree/main/docs/dev/https-dev-url-cors

Scripts used in project

npm run check checks the formatting of all the files in the project. This script runs in a pre-commit hook. It will warn about the improper formatting present in the file.
npm run fix can be run for fixing the formatting before commiting your changes or to solve the formatting errors one may get while commiting the changes.

Note ⚠️ : Do run these scripts before raising the PR

CSS Structure

Global CSS

main.css
- This css file will contain common css pertaining to all pages that can be used throughout the website.
- For example, a class with name success, when used anywhere throughout the website will make the color of the text green.

Page specific CSS

For example, events page css goes inside events.css.
Also, in future if we add new components, we will keep component specific css like navbar.css, footer.css, header.css etc.
For mobile responsive css, we can have a folder with multiple css files catering to different css pertaining to different resolutions.

website-www's People