🗳️ This project is going to be the default front-end for our election application.
💻 It is connected to our back-end. The back-end is used for storing the votes and computing the majority judgment ranking. You can use our back-end free of charge, but you can also start your own instance of the back-end using our Dockerfiles.
📨 The front-end is responsable for sending the invitation mails. You can find the mail templates on the functions folder.
🗺️ The front-end stores its own translations. See below how you can edit them easily.
The separation between the front-end and the back-end makes it easy to customize your own application. Just install
Option one: One-click deploy
Option two: Manual clone
- Clone this repo:
git clone https://github.com/MieuxVoter/majority-judgment-web-app.git - Navigate to the directory and install dependencies:
npm installormake - Start a local server:
npm run devand open http://localhost:3000 with your browser to see the result. - Make your changes
- Deploy your project.
We advise for deploying the project to Netlify, because we wrote the mail functions for the framework. Netlify parameters are written in netlify.toml.
If you decide to deploy your project in another way, please fill a pull-request to guide futur users!
To add support for mail sending, you need to connect the application with a mailing service. For now, we only support Mailgun, which offer very competitive prices. You can fill an issue if you require another mailing service.
To connect your application with Mailgun, you need to add the environment variables to your project:
MAILGUN_API_KEY,MAILGUN_DOMAIN,MAILGUN_URL,FROM_EMAIL_ADDRESS,REPLY_TO_EMAIL_ADDRESS.
You can add the environment variables on an .env file or directly on Netlify.
You can directly modified the translation files in the folder public/locales.
In case you want to add support for another language, you need as well to add it on net-i18next.config.js and on the LanguageSelector component.