Skip to content

Development Onboarding (Windows)

Jump to bottom
Burra Abhishek edited this page Aug 7, 2021 · 7 revisions

The following instructions outline how to set up your development environment on Windows to run this app or contribute to this repository.

Getting Help

If you face any issues while setting up your development environment, open a suitable issue on the main repository.

Pre-requisites

Software

  • A text editor for writing code. Notepad is sufficient.
  • A web browser to run the application. A modern web browser like Google Chrome, Mozilla Firefox, or Microsoft Edge is recommended. If you are using Internet Explorer, note that only Internet Explorer 11 is supported because other versions do not support CSS flexbox.
  • A web server to host the web application. This application won't work on the file:/// protocol because it uses a database. You can run this application locally using localhost.
  • PHP >= PHP7
  • An SQL database, because the database is an SQL database.
  • git, if you want to write code for this application

Installing software:

  1. Text Editor
    • You don't really require a text editor. Notepad is pre-installed with Windows. You can skip this step.
    • Alternatively you might want to install an IDE to write code easily. You can install any IDE of your choice.
  2. Web Browser
    • If you already have a modern version of Google Chrome, Microsoft Edge (Chromium), Internet Explorer 11, Mozilla Firefox, or any other modern web browser, you can skip this step.
    • Otherwise, it is recommended to install any of these browser(s). You might need them for day-to-day browsing activities, so think about it!
  3. A web server
    • For those who are new to SQL-based website development, XAMPP and WampServer are two very popular choices. You can install any one of them and get started.
  4. Git
    • If you want to run this application without any version control, you can skip this step.
    • If you are writing code for this application, it is recommended to have git installed.

Getting started

  1. Install all the above prerequisites and note the repository location:

    • If you're using XAMPP, clone the repository to XAMPP\htdocs folder.
    • If you're using WampServer, clone the repository to wamp\www or wamp64\www depending on the installed version (32-bit or 64-bit) of WampServer.
    • For all other web servers, clone it to the respective project folder.

  2. After installing all the pre-requisites, either download this repository, or clone it to the above location using:

> git clone https://github.com/BurraAbhishek/VirtualElections.git

  1. Start your web server.

    • If you're using XAMPP, Start Apache and MySQL modules.
    • If you're using WampServer, start all services and ensure that the system tray icon is green.

  2. Open a web browser, and type localhost. If a welcome screen appears, then your local web server was successfully installed.

  3. Now go to localhost/<Repository>/src/index.html. Replace <Repository> with the name of the repository stored in htdocs. You should be able to see the homepage.

  4. Go to localhost/<Repository>/src/admin/getstarted.html and follow the instructions in that page.

Clone this wiki locally