Skip to content

Latest commit

 

History

History
87 lines (56 loc) · 2.1 KB

README.md

File metadata and controls

87 lines (56 loc) · 2.1 KB
Raw

Le Classement des Associations Le Classement des Associations

vote.le-classement.fr

This project is a voting platform for "Le Classement des Associations".

All the participating associations are present with the different reports they could provide us. Anyone can come and vote with an email address and the two associations with the most votes go directly to the final.

Tech Stack

Client: TailwindCSS, Alpine.js, Unpoly.js

Server: AdonisJS

Run Locally

Clone the project

  git clone https://github.com/Barbapapazes/vote.le-classement.fr

Go to the project directory

  cd vote.le-classement.fr

Install dependencies

  npm ci

Start the server in development mode

  npm run dev

To be sure everything is working fine, you must also have a running PostgreSQL with a database for this project.

Environment Variables

To run this project, you will need to copy .env.example to .env and fill every lines.

For the mail service, you can choose a local MailHog, any mailing service with SMTP or SES.

The env ENABLE_VOTE can be set to true or false to enable or disable the voting feature, useful to start and stop easily the voting process.

Deployment

To deploy this project run

  # Build server
  npm run build

  cd build
  npm ci --production
  # Start server
  node server.js

You can learn more about deployment in documentation!

License

MIT

Authors