This is a guide to explain the working of this code and how you can contribute to this repository without causing any unexpected errors.
There are some steps that you need to follow to setup this project in your own local machine.
- Clone this repository
git clone {{Link of this repo}}- Install the dependencies
yarnIf you do not have yarn on your machine, please use :
npm install yarn --globalIf you do not have npm on your machine, please go Here and Install the LTS version, it comes bundeled with npm by default
-
Opening the project in the browser
- Dev Mode (With Tailwind Watch)
yarn start
- Server (Without Tailwind Watch)
yarn serve
- Make a fork of this repo by clicking on the fork button in the top right corner on github
- Clone the forked repo to your local machine by performing the above mentioned steps
- Make your changes
Details about this part are given below
- Push your code to github
- Create a pull request with the updated code
- Make a new folder in the
/rootdirectory - Put your files in that folder
- Open
./index.htmlpresent in the root directory - Press
CTRL + Fand search the name of the section that were assigned to work on - Add links in the required pages from the navbar itself
This component is spaning upto 1340 lines
- Test your changes on localhost
- Complete the contributing process