You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

63 lines
3.1 KiB

2 years ago
# Front-end election web application using NextJs
3 years ago
2 years ago
[![Netlify Status](](
2 years ago
[![Join the Discord chat at](](
2 years ago
:ballot_box: This project is going to be the default front-end for our [election application](
2 years ago
:computer: 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.
2 years ago
:incoming_envelope: The front-end is responsable for sending the invitation mails. You can find the mail templates [on the functions folder](./functions/send-invite-email).
2 years ago
:world_map: The front-end stores its own translations. See below how you can edit them easily.
2 years ago
## :paintbrush: Customize your own application
2 years ago
The separation between the front-end and the back-end makes it easy to customize your own application. Just install
2 years ago
## :gear: Install options
**Option one:** One-click deploy
2 years ago
[![Deploy to Netlify](](
2 years ago
**Option two:** Manual clone
1. Clone this repo: `git clone`
2. Navigate to the directory and install dependencies: `npm install` or `make`
3. Start a local server: `npm run dev` and open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
4. Make your changes
5. 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!
## :incoming_envelope: Support for mail
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:
You can add the environment variables on an `.env` file or directly on [Netlify](
## :world_map: I18N at heart
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.