Skip to content

Mirror of the Agora-web-frontend Project

License

Notifications You must be signed in to change notification settings

AOSSIE-Org/Agora-web-frontend

Repository files navigation

Agora-Web Frontend

Readme

Frontend for Agora Web that uses Agora: An Electronic Voting Library implemented in Scala. This application uses Agora Web API as backend application

This project is created using the Angular 8 web framework.

To run the development environment for this frontend, you need Git and Node.js installed.

Table of contents

Installation

Make sure you have the Angular CLI installed globally. We use NPM to manage the dependencies, so we strongly recommend you to use it. you can install it from Here, then run npm install to resolve all dependencies (might take a minute).

Running the application

To use Facebook login you will need to change the following in app.module.ts { id: FacebookLoginProvider.PROVIDER_ID, provider: new FacebookLoginProvider("Your app id here") } For more information visit Angularx-social-login

Run ng serve for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.

Building the application

Run ng build to build the project. The build artifacts will be stored in the dist/ directory. Use the --prod flag for a production build.

Deployment

The current development branch is deployed on heroku and is available at http://agora-frontend.herokuapp.com/

Troubleshooting your local environment

Always git pull and get the latest from master. Google and Stackoverflow are your friends. You can find answers for most technical problems there. If you run into problems you can't resolve, feel free to open an issue.

Contributing code

Any and all contributions to the project are welcome.

Issues tagged as good first issue should be a good place to start.

If you're ready to contribute code, see the contribution guide.

Further Reading / Useful Links

  • Node.js - Provides the package manager used in this project
  • Agular CLI - Command line tool required to work with application
  • Angular 8 - The web framework used to build this project
  • Bootstrap - HTML and CSS frontend framework