Installation Guide
In order to run this application on your local system, you'll need to fulfill a few requirements.
- Your system should have node.js installed. This application was made using v14.18.1, but the current LTS version should work.
- You should have Node Package Manager(npm) installed. This is usually installed along with node.js, and you won't have to install it manually. This application was made using v6.14.15 but it should work with any v6.x.x installation. You can also use PNPm or Yarn if you wish.
That's all you need to run the application on your system. Next, we move on to package installations for the project.
All system binaries were installed in the previous step, but you still need to install the packages required by the project. But before that, you need to install the files for the application. These can be downloaded from the button below.
The button above would download you a ZIP file containing the code for the frontend web application. You'll need to unzip it and move it to the desired location on your disk.
Now, open the downloaded folder in your terminal/command prompt and enter the command npm install. or if you are using Yarn or PNPm, you can change the command accordingly.
This will take a while, so sit back and relax. After this is done, there are chances that you might encounter some dependency vulnerability alerts, but it is advisable to leave them as it is unless you know what you are doing. That's it. Your web application is installed.
Refer Setting up the environment variables for this step.
To start your application, type npm run dev and your application will be accessible on http://localhost:3000 on you browser.
Keep in mind that this is only the frontend of the application and you'll need to install that backend files too, if you haven't already done that.