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
63 lines
3.1 KiB
# Front-end election web application using NextJs
|
|
|
|
[](./LICENSE.md)
|
|
[](https://app.netlify.com/sites/epic-nightingale-99f910/deploys)
|
|
[](https://discord.gg/rAAQG9S)
|
|
|
|
|
|
:ballot_box: This project is going to be the default front-end for our [election application](https://app.mieuxvoter.fr).
|
|
|
|
:computer: It is connected to our [back-end](https://github.com/MieuxVoter/mv-api-server-apiplatform). 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.
|
|
|
|
: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).
|
|
|
|
:world_map: The front-end stores its own translations. See below how you can edit them easily.
|
|
|
|
|
|
## :paintbrush: Customize your own application
|
|
|
|
The separation between the front-end and the back-end makes it easy to customize your own application. Just install
|
|
|
|
|
|
|
|
## :gear: Install options
|
|
|
|
**Option one:** One-click deploy
|
|
|
|
[](https://app.netlify.com/start/deploy?repository=https://github.com/MieuxVoter/mv-front-react&utm_source=github)
|
|
|
|
|
|
**Option two:** Manual clone
|
|
|
|
1. Clone this repo: `git clone https://github.com/MieuxVoter/mv-front-nextjs.git`
|
|
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](https://netlify.com), 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](mailgun.com), 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`,
|
|
- `CONTACT_TO_EMAIL_ADDRESS`.
|
|
|
|
You can add the environment variables on an `.env` file or directly on [Netlify](https://docs.netlify.com/configure-builds/environment-variables/).
|
|
|
|
|
|
## :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.
|
|
|