2019-10-25 14:59:20 +02:00
|
|
|
#Funky Framadate API
|
2019-11-27 20:55:59 +01:00
|
|
|
Experimental REST backend in symfony 4 for Funky framadate frontend.
|
|
|
|
https://framagit.org/framasoft/framadate/funky-framadate-front
|
|
|
|
|
|
|
|
|
2019-11-06 11:12:16 +01:00
|
|
|
|
|
|
|
***
|
2019-11-27 20:55:59 +01:00
|
|
|
# Development
|
2019-11-06 11:12:16 +01:00
|
|
|
install dependencies with Composer
|
|
|
|
|
2019-11-27 20:55:59 +01:00
|
|
|
|
|
|
|
there are examples of request to make it all work.
|
|
|
|
## Getting started
|
|
|
|
### install the vendors
|
|
|
|
```bash
|
|
|
|
composer install
|
|
|
|
```
|
|
|
|
### initiate the database
|
|
|
|
```bash
|
|
|
|
php bin/console doctrine:schema:create
|
|
|
|
```
|
|
|
|
### launch local server with
|
2019-11-06 11:12:16 +01:00
|
|
|
```bash
|
|
|
|
php bin/console server:run
|
|
|
|
```
|
2019-11-27 20:55:59 +01:00
|
|
|
|
|
|
|
|
2019-11-06 11:12:16 +01:00
|
|
|
# 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
|
|
|
|
|
2019-11-20 11:32:38 +01:00
|
|
|
## 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/clean-polls
|
|
|
|
```
|
2019-11-27 20:55:59 +01:00
|
|
|
you can open your crontabl in command line with :
|
|
|
|
```
|
2019-11-20 11:32:38 +01:00
|
|
|
crontab -e
|
2019-11-27 20:55:59 +01:00
|
|
|
```
|
2019-11-06 11:12:16 +01:00
|
|
|
# About
|
|
|
|
|
|
|
|
made by B. Lemoine, aka Tykayn, for the framadate funky front end project, a polling libre software.
|
|
|
|
## contacts
|
2019-11-27 20:55:59 +01:00
|
|
|
* contact@cipherbliss.com
|
|
|
|
* https://mastodon.cipherbliss.com/@tykayn
|
|
|
|
* https://keybase.io/tykayn
|
|
|
|
* https://twitter.com/tykayn
|
|
|
|
* https://cipherbliss.com
|