#Funky Framadate API REST backend in symfony 5 for Funky framadate frontend. https://framagit.org/framasoft/framadate/funky-framadate-front

TODO:

• coordinate properties and paths to be more restful.

return stack of votes when we want to get the configuration of one poll (see doc/examples.md)

---

Requirements

You MUST have php version 8+ (see installation doc) and Composer, and a database like Mysql, or postgresql, or mongodb, or any database that Doctrine can handle. Setup access to database by creating a .env.local file, and fill the database user and password data. you can check that the database connection works with the command:

php bin/console doctrine:schema:validate

Getting started

Follow this guide to setup.

Development

install dependencies with Composer

configure env by creating local env file

cp .env .env.local

and edit the file variables to give access to database.

Launch dev server with the "symfony" cli tool:

symfony serve

there are examples of request to make it all work in the doc/examples.md.

Check prerequisites

composer check-platform-reqs

install the vendors

composer install

#Funky Framadate API Experimental REST backend in symfony 5 for Funky framadate frontend. https://framagit.org/framasoft/framadate/funky-framadate-front

Follow this guide to setup.

• run composer install configure env by creating local env file cp .env .env.local and edit the file variables to give access to database.

TODO:

• coordinate properties and paths to be more restful. https://stackoverflow.blog/2020/03/02/best-practices-for-rest-api-design/

return stack of votes when we want to get the configuration of one poll (see doc/examples.md)

---

Requirements

You MUST have php version 8+ and Composer, and a database like Mysql, or postgresql, or mongodb, or any database that Doctrine can handle. Setup access to database by creating a .env.local file, and fill the database user and password data. you can check that the database connection works with the command:

php bin/console doctrine:schema:validate

Getting started

Development

install dependencies with Composer

there are examples of request to make it all work in the doc/examples.md.

Check prerequisites

composer check-platform-reqs

install the vendors

composer install

configure database access in .env.local file

This project can use any database system, we provide config for mysql.

If you need to setup mysql, a database and a user, read the database_creation doc. Before customizing your local environment config. the .env.local file will not be versionned by git, so no risk to set the mysql credentials in here as long as file access are well done.

You can copy the model env file and customize it last line to access mysql.

cp doc/env-example .env.local

look for the line like this

DATABASE_URL=mysql://framadate-admin:framadate-admin-password@127.0.0.1:5432/framadate-api

and change its values for framadate-admin , framadate-admin-password, framadate-api.

initiate the database with fixtures

php bin/console doctrine:schema:drop --force
php bin/console doctrine:schema:create
php bin/console doctrine:fixtures:load --no-interaction --purge-with-truncate

launch local server with

php bin/console server:run

Production

set a virtual host on your server, configure CORS access to have the API to work. configure database access in a .env.local file , replace variables DATABASE_URL=mysql://database_user:db_user_password@127.0.0.1:3306/database_name this file is not versionned and should stay like this.

cronjob to delete expired polls

add this line in your crontab to run the clearance of expired polls everyday at 0h00.

0 0 * * * wget http://MYWEBSITE/api/v1/poll/clean-polls 

you can open your crontabl in command line with :

crontab -e

About

made by B. Lemoine, aka Tykayn, for the framadate funky front end project, a polling libre software.

contacts

• contact@cipherbliss.com
• https://mastodon.cipherbliss.com/@tykayn
• https://twitter.com/tykayn
• https://cipherbliss.com