||1 year ago|
|.circleci||1 year ago|
|.github||3 years ago|
|components||1 year ago|
|cypress||1 year ago|
|functions/send-invite-email||2 years ago|
|pages||1 year ago|
|public||1 year ago|
|services||1 year ago|
|styles||1 year ago|
|.eslintrc.json||3 years ago|
|.gitignore||1 year ago|
|.nvmrc||1 year ago|
|LICENSE||3 years ago|
|README.md||1 year ago|
|cypress.json||1 year ago|
|i18n.config.js||3 years ago|
|jsconfig.json||2 years ago|
|netlify.toml||1 year ago|
|next-i18next.config.js||2 years ago|
|next.config.js||1 year ago|
|package.json||1 year ago|
|yarn.lock||1 year ago|
Front-end election web application using NextJs
🗳️ 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.
🖌️ Customize your own application
The separation between the front-end and the back-end makes it easy to customize your own application. Just install
⚙️ Install options
Option one: One-click deploy
Option two: Manual clone
- Clone this repo:
git clone https://github.com/MieuxVoter/mv-front-react.git
- Navigate to the directory and install dependencies:
- Start a local server:
yarn 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
If you decide to deploy your project in another way, please fill a pull-request to guide futur users!
This app is based on Mieux Voter API. If you need to install it locally, clone the project and launch it thanks to
docker-compose up. In this project (
mv-front-react), create a
.env file and add
export NEXT_PUBLIC_SERVER_URL='http://localhost' in it.
📨 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.
🗺️ I18N at heart
You can directly modified the translation files in the folder
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