Contribution
Running Locally

Running Locally

To run the FEDS-Handbook locally, you will need to follow these steps:

Clone the Repository

Clone Repository


Click on the "Code" button on FEDS-Handbook's GitHub repository and copy the URL.

Clone Repository


Click on the "Clone Git Repository" button in VS Code and paste the URL in the Command Pannel. This will clone the repository to your local machine.

Save the repository in a location where you can easily access it.

Open the Repository in VS Code

Now that you have cloned the repository, open it in VS Code by clicking on the "Open Folder" button in the Welcome view.

Installing Packages

Open the Terminal

Terminal

Click on the Terminal tab in the Activity Bar on the side of the window. This will open the Terminal view, where you can run commands.

Install Packages

Run the following command in the terminal to install the necessary packages for the FEDS-Handbook:

npm install

This command will install all the packages listed in the package.json file.

You may see some warnings during the installation process. These warnings are usually safe to ignore.

If you encounter "npm ERR! code ERESOLVE" errors, you can try running the following command to fix them:

    PS C:\Users\pyintel-admin\code\whiteboard\frontend> npm run start
 
        > whiteboard@0.0.0 start
        > ng serve
 
        This program is blocked by group policy. For more information, contact your system administrator.

Please refer to the InstallingApplication , run the command and then try running npm install again.

Voila!

You have successfully installed the necessary packages for the FEDS-Handbook. You are now ready to start contributing to the documentation!

Running the Application

Start the Development Server

Run the following command in the terminal to start the development server for the FEDS-Handbook:

npm run dev

This command will start the development server and open the FEDS-Handbook in your default web browser.

Explore the Application

Application

Explore the FEDS-Handbook to see the changes you have made. You can navigate through the pages and view the content you have added or modified.

Voila!

You have successfully run the FEDS-Handbook locally. You can now make changes to the documentation and see the results in real-time!

Opening Visual Studio CodePushing to Github