jolicode / starfleet

:rocket: Share your conferences activity to your buddies

Starfleet

Share your conferences activity to your buddies

Requirements

A Docker environment is provided and requires you to have these tools available:

• Docker
• Bash
• PHP >= 8.1
• Castor

Castor

Once castor is installed, in order to improve your usage of castor scripts, you can install console autocompletion script.

If you are using bash:

castor completion | sudo tee /etc/bash_completion.d/castor

If you are using something else, please refer to your shell documentation. You may need to use castor completion > /to/somewhere.

Castor supports completion for bash, zsh & fish shells.

Docker environment

The Docker infrastructure provides a web stack with:

• NGINX
• PostgreSQL
• PHP
• Traefik
• A container with some tooling:
  • Composer
  • Node
  • Yarn / NPM

Domain configuration (first time only)

Before running the application for the first time, ensure your domain names point the IP of your Docker daemon by editing your /etc/hosts file.

This IP is probably 127.0.0.1 unless you run Docker in a special VM (like docker-machine for example).

Note: The router binds port 80 and 443, that's why it will work with 127.0.0.1

echo '127.0.0.1 local.starfleet.app' | sudo tee -a /etc/hosts

Starting the stack

Launch the stack by running this command:

castor start

Note: the first start of the stack should take a few minutes.

The site is now accessible at the hostnames your have configured over HTTPS (you may need to accept self-signed SSL certificate if you do not have mkcert installed on your computer - see below).

SSL certificates

HTTPS is supported out of the box. SSL certificates are not versioned and will be generated the first time you start the infrastructure (castor start) or if you run castor infra:generate-certificates.

If you have mkcert installed on your computer, it will be used to generate locally trusted certificates. See mkcert documentation to understand how to install it. Do not forget to install CA root from mkcert by running mkcert -install.

If you don't have mkcert, then self-signed certificates will instead be generated with openssl. You can configure infrastructure/docker/services/router/openssl.cnf to tweak certificates.

You can run castor infra:generate-certificates --force to recreate new certificates if some were already generated. Remember to restart the infrastructure to make use of the new certificates with castor up or castor start.

Builder

Having some composer, yarn or other modifications to make on the project? Start the builder which will give you access to a container with all these tools available:

castor builder

Other tasks

Checkout castor to have the list of available tasks.

Usage

By default, the fetchers are not configured and won't fetch anything. You first need to head to the admin and configure them in the fetcher menu, then you can run inv fetch-conferences.

If you want to add a source, you only have to implement the FetcherInterface.

Some fetchers will use tags to fetch their data, and some of these tags may be missing. If this is the case, you should find the fetcher in src\Fetcher and add the missing tag to its tags list.

Slack

Starfleet uses strong integration with Slack as it sends daily Slack notifications. You must create a Slack application if you don't have any. You need to configure a webhook at https://[your-slack-organization].slack.com/apps/A0F7XDUAZ-incoming-webhooks and add it to the SLACK_WEB_HOOK_URL env variable. Since Starfleet uses user interaction, you must configure your application at to allow user interaction. You may see how to do it at https://api.slack.com/interactivity/handling#setup. Your Slack Signing Secret should be stored in the SLACK_SIGNING_SECRET env variable. During dev, you may use Ngrok to let Slack reach your application. We provide a command to start Ngrok : inv ngrok. Paste the resulting address in your Slack app Request URL field.

Map

We provide you with the possibility of adding a map with a marker on every location you and your team attended a conference. If you want to enable this feature, you need to create an account at Mapbox. You then need to retrieve your API Token and add it to your .env file, by replacing the default value of the MAPBOX_TOKEN variable.

Translations

To add easily add new translations, please install and use i18n-ally.

Changes

View the CHANGELOG file attached to this project.

Sponsor

Open Source time sponsored by JoliCode

Credits

• All contributors

License

View the LICENSE file attached to this project.

starfleet's Issues

Manage conference participations (as admin, as user)

As an admin, I want to see the conferences that users are interested in, the ones they ask to attend. They can request to participate, then I could validate or reject these requests.

Once the request has been validated, I can indicate the status of the next steps: transport tickets, hotel booking, conference tickets...

A participation request can be opened by any user, but if they got a pending submission or they are speaker to the conference, they must mention it in the request (checkbox for it).

Each user will have statistics on his participations/submissions (accepted and rejected). These statistics will be displayed to admin, to let theme decide to accept or reject requests.

Rework translation management

We are waiting for https://github.com/php-translation/symfony-bundle compatibility with Symfony >= 4.3 to rework all our translation message and allows Starfleet translation in other languages than English.

Update EasyAdmin to 2.1

Update EasyAdmin from 1.x to 2.1

AA user I want to add talk and submit to a conference easily

As a user, I want to submit a talk to a conference in the easiest way possible.

Technically, we have to add a Conference field to the talk creation form, that automatically create a submit between the new talk and the conference. The aim is to avoid the user to manually create a Submit object for a new talk.

For an existing talk, we can add a collection form to the talk edition form, to let the user add a new submit of their talk. In this way, we can remove Submit menu entry, which is not really necessary for the user.

Extract filtering / tag grouping from fetch. It not the right place to do that

The fetch has too much responsability.

1. The public method in the interface that are not used outside must be removed from the interface
2. The tag filter + group should be move outside fetchers

Update the concept of "Tag" -> FetcherConfiguration

Tag does not really work ATM. It's used to filter what we want to grab thanks to fetchers.
But fetchers has also their own "tag" that is own by their API.

So the goal of this issue is:

• Remove the Tag concept (entity + all related code)
  • for the entity Conference, use a plain array in place of the current relation (please, migrate all existing data)
• Add a new concept : FetcherConfiguration
  • add a new entity: id, className, configuration
  • add public function buildForm(): FormBuilderInterface (not sure ATM about the return type) in FetcherInterface
  • use the form in the admin, to configure each fetcher
  • If it's easy, let's be nice: add a way to create a new record for each fetcher if it does not exists in the DB yet
  • At runtime, each fetcher should get it's configuration. But IMHO, this should be delegate to the service that call the fetcher. So maybe update the interface FetcherInterface::fetch(array $configuration): \Generator

AA user I want to win badges for done talks

After a user has given n talks, he can win different badges, corresponding to Starfleet grades.
We can base the badges on this:

Add a CHANGELOG file

0.1 (alpha)
- Initial release

Setup CI

• Finish docker dev stack

• Add CI configuration to run tests, check coding style, check linting, etc

Can't access Participation list page

After upgrade EasyAdmin from ^2.1 to ^2.3, this Pull Request introduces a Breaking Change and results on a 500 Error on Participation list page

Improve admin panel with Role based access

As admin, I can manage User CRUD, Conference CRUD, Participation CRUD (+ workflow), Tag CRUD.

As user, I can only manage my Talks CRUD, my Participation CRUD.

As it is said here EasyCorp/EasyAdminBundle#2810 we should be able to use native permission feature of EasyAdmin soon 🎉

Do not prefill authors field with current user during a submit edition

I wanted to update @Korbeil submits for Afup conferences, and I figured out that Starfleet pre fill Authors fields with only me. It's not what we want here. It's ok for Submit creation form, but not for edition form.

Replace the 404 page by a nicer 403 when accessing a random conference

All the conference links are displayed and active in the Starfleet Slack integration. If I tried to use one of this link for a random conference (where I'm not), the destination page is a 404 instead of "something" to inform me properly that I just have to participate to to this conference to see more information.

I suggest to replace this page by a 403, or a minimal page with few informations, and a form to submit a talk.

Additionally, is it really relevant to have links to 404/403 (for many users) ? It could be smart to activate links in Slack messages only for allowed users/organisations.

Write documentation

• Installation documentation
  • [local] Classical way
  • [local] Docker way
  • PaaS : heroku, clever-cloud, sensio.cloud, ...

---

• Configuration
  • Add tags
  • Add Google oAuth keys
  • Restrict login to your Google Apps domain
  • Create Slack webhook

---

• Usage
  • Fetch conferences daily
  • Notifications about CFP, talks submission, talks status, ...

Add Symfony Live conferences source

Based on this JSON, we can import all Symfony Live|World|Con conferences : https://live.symfony.com/api/conference/all.json

We need to add a new Fetcher for this source

AA User I want Starfleet asks me on Slack if my pending talks are accepted/rejected

I want to receive a private message from Starfleet bot to asks if my pending talks for recently closed CFP are accepted or rejected.

2 choices in the notification message as links. Just click on it to update my talk in Starfleet.

---

Slack playground:

https://api.slack.com/docs/messages/builder?msg=%7B%22text%22%3A%22Would%20you%20like%20to%20play%20a%20game%3F%22%2C%22attachments%22%3A%5B%7B%22text%22%3A%22Choose%20a%20game%20to%20play%22%2C%22fallback%22%3A%22You%20are%20unable%20to%20choose%20a%20game%22%2C%22callback_id%22%3A%22wopr_game%22%2C%22color%22%3A%22%233AA3E3%22%2C%22attachment_type%22%3A%22default%22%2C%22actions%22%3A%5B%7B%22name%22%3A%22game%22%2C%22text%22%3A%22Chess%22%2C%22type%22%3A%22button%22%2C%22value%22%3A%22chess%22%7D%2C%7B%22name%22%3A%22game%22%2C%22text%22%3A%22Falken%27s%20Maze%22%2C%22type%22%3A%22button%22%2C%22value%22%3A%22maze%22%7D%2C%7B%22name%22%3A%22game%22%2C%22text%22%3A%22Thermonuclear%20War%22%2C%22style%22%3A%22danger%22%2C%22type%22%3A%22button%22%2C%22value%22%3A%22war%22%2C%22confirm%22%3A%7B%22title%22%3A%22Are%20you%20sure%3F%22%2C%22text%22%3A%22Wouldn%27t%20you%20prefer%20a%20good%20game%20of%20chess%3F%22%2C%22ok_text%22%3A%22Yes%22%2C%22dismiss_text%22%3A%22No%22%7D%7D%5D%7D%5D%7D

Add conferences from awesome-cfp

This repo list conferences mainly in France https://github.com/lauthieb/awesome-cfp/

We could crawl it to fill up Starfleet

Allow to filter the list of next conferences

Same idea as #3, the conference listing is too hard to read.

We have +180 conferences incoming and can't filter the one we could really go to.

Allow to filter by:

• city
• country
• topic
• tags
• start and end date
• number of days

Thanks!

Implement other login methods

• Add a classic email/password method
• Add a GitHub login (with organization restriction if possible)

Display a map with all location where we went at conferences

Diffrent types of markers:

• Conferences where we went as spectator
• Conferences where we went as speaker
• Conferences where we were sponsor (could be a star over other marker)

[Participations] Improve feature

• Automatically select the logged user in form
• Apply filter on Conference list like from 10/19 to 12/19 (globally, apply filters for all app on countries, tags, dates ...)
• Adapt workflow places according to needs (ticket, hotel or transport). Don't ask for unnecessary places.

Add PHPStan to the projet

• add plugin for Symfony
• add plugin for Doctrine

Foreign key violation when deleting a user or a conference

There is a bug when trying to delete a user or a conference in Easy Admin.

If you try to delete a user, the foreign key of that user is still referenced in the participation table, raising this exception :

The same occurs with some conferences, but not all of them (I don't know why, it may be because of the fixtures), because the key is still referenced in the submit table.

A quick solution would be to remove the possibility to delete a user or a conference in the admin, but ultimately a decision should should be taken about whether or not we want to completely remove all participations of deleted users. Same goes with conferences : if we delete a conference, do we want to delete all submits referencing this conference ?

Add more data sources

Todo:

• Create FetcherInterface
• Implement this interface to create a fetcher for https://raw.githubusercontent.com/tech-conferences/conference-data/master/conferences/2019/php.json
• Modify the command starfleet-conferences-fetch to let it call the fetcher
• Compute a hash from conference.slug (cleaned: remove year for instance)+conference.startAt+conference.endAt to check if we already have the conference in database
• The fetcher fetch method must return an array of Conference entities
• Save conferences in database

We will improve fetchers with other sources in near future.

---

Help

See:

• https://github.com/tech-conferences/conference-data
• http://api.joind.in/

Add conferences from CFP Land

URL : https://www.cfpland.com/
API : https://cfpland.github.io/api-docs/

Add region filter on fetching

It could be useful to avoid fetching conference placed on the other side of the world. So, we want to filter conference fetching on region (by continent, by country). For fetchers without this filter possibility, we want to filter after fetching, before persist on database.

Take a look to neonmoire.com

https://www.neonmoire.com/ is curated list of events, festivals and conferences.

Add country flag on the conference listing

I want a little flag (emoji 🇫🇷) on each conference to quickly identify which country the conference take place in.

Update Bootstrap

GitHub alerts us about a security vulnerability from our Bootstrap version.

Todo

• Update Bootstrap

We found a potential security vulnerability in one of your dependencies. You can see this message because you have been granted access to vulnerability alerts for this repository. Manage your notification settings or learn more about vulnerability alerts.

Add conference location to Slack message

Explicit title ;)

Fix double Slack message for added conferences

Sometimes we have Slack message in double for new added conferences. We need to investigate to find why and fix it.

In otherwise, we also have "empty" Slack message with only CFP link as CFP reminder message. May be it is because we do not have conference data? Needs investigation too.

Add conferences from CallingAllPaper

URL : https://api.callingallpapers.com/v1/cfp
Format : json
Tags : yes, but by conference

Add conferences from tulula

URL : https://tulu.la/call-for-papers/
France URL : https://tulu.la/call-for-papers/?in=France

The way we search for an existing conference does not scale

ATM, we loop over all conference to find it a conference exist.
This does not scale.

starfleet/src/Command/FetchConferencesCommand.php

Lines 101 to 113 in e91cc7d

	protected function retrieveConferenceIfExists(Conference $conference): ?Conference
	{
	$currentConferenceName = preg_replace('/(20)[0-9][0-9]/', '', $conference->getName());
	$matchedConference = null;
	$existingConferences = $this->conferenceRepository->getAllConferencesAsRow();
	$shortest = -1;
	foreach ($existingConferences as $existingConference) {
	$existingConferenceName = preg_replace('/(20)[0-9][0-9]/', '', $existingConference['name']);
	$distance = levenshtein(strtolower($currentConferenceName), strtolower($existingConferenceName));

---

Please, find a way to avoid that. But before coding anything, please expose the algo (here if you're hot, or in slack it's fine)

When editing talk, wrong status is selected

When you go in the Talks listing then edit a talk. Old status is not selected.
For example if you have a submission with "Refused" status, it will go back to "In progress" during edit.

See below 👇 for example

Properly handle online conference

ATM, we are using city="online" to do that. This is not really clean.

• Let's add a real flag in the DB.
• Existing data should be migrated too
• Update all part of the code using this

Add a submission to an existing talk

When we have an existing talk and we try to add a new submission, we have a 500 error.

Add a whitelist/blacklist system to filter more precisely conference fetching

The actual fetching system is not ideal. We fetch all conferences based on a tags list. But for instance at JoliCode we fetch all PHP conference, including TYPO3 conference, which is a CMS that we do not use. So, we would like to manage a blacklist of tags and words contained in conferences name to avoid fetching them.

The behaviour should be:
We fetch all conferences based on the whitelist of tags, and we remove all matching conferences on the blacklist, then we record the result of this filtering.

As a user, we don't know the type of talk.submittedAt

Separate user account from admin panel?

The admin is dedicated to administrators, users should have their own "account" area to manage their information, their participation requests, etc ...

Manage conference sponsoring

As admin,
I want to manage conference sponsoring:

• Create a sponsoring for a conference (amount, level ...)
• Get notifications regularly before the event (to order goodies, order kakemono ...)

Is it really useful for concerned people like @RozennB and/or @xavierlacot ?

Improve Participation system

As Admin, I want the users to let me know which conference they want to participate to. They could request to attend to a conference through a page with conferences list and I want to be able to accept or reject those demands on an admin page with filter by user.

I want to build the list of conferences from which users can request for participation from an admin page.

Todo

• Automatically select the logged user in form
• Apply filter on Conference list like from 10/19 to 12/19 (globally, apply filters for all app on countries, tags, dates ...)
• Adapt workflow places according to needs (ticket, hotel or transport). Don't ask for unnecessary places.

Add pagination on Conferences page

• Separate past conferences, incoming conference, and live conferences in 3 tabs
• For each tab, add a pagination

Move static site to another repo

Static Stafleet site used to present the application should be moved in another repo.

Add common information about attendees on user profiles

As admin, I want to retrieve easily users information to fill in faster and easier conference ticket forms.

• Job title
• Twitter account
• t shirt size
• food preferences
• allergies

Improve Talks list view on admin

The actual talks list view is very "empty"

It should be great to add some columns like "authors", "created at", … In this way, it will be possible to filter on these fields to easily retrieve Talks.

Add conferences from OpenCFP

Search "Powered by OpenCFP" on Google 👍
https://www.google.fr/search?q=powered+by+opencfp&oq=powered+by+opencfp&aqs=chrome..69i57.5207j0j9&sourceid=chrome&ie=UTF-8

OpenCFP provides an API that gives us information about the conference. It could be useful to find PHP conferences.

Display a page with all given talks with videos, slides ...

We could display a page with all given talks with more data:

• Videos (if exists)
• Slides (link or embed)
• GitHub (if exists)
• Twitter
• Language

Add init command to create first admin user

For new installation of Starfleet, we need to let people init the application with at least one user with ROLE_ADMIN. It can be done with a command like starfleet:init which asks for an email, a password and some others things required to start using Starfleet (like Slack webhook).

Find a way to avoid duplicated conferences

For now, we have 2 conferences sources (JoindIn API and Conf Tech JSON files).
Sometimes, we fetch the same conference from each source, but the name is not exactly the same.

For instance, "Forum PHP" in Conf Tech, and "Forum PHP 2020" in JoindIn API.
Both has the same dates, but not the same name, and not the same CFP url (https://afup.org/event/forumphp2020 and http://cfp.afup.org/).

To avoid this, @lyrixx gives us an hint: https://www.php.net/manual/en/function.levenshtein.php

We could match the incoming conferences to the existing ones with levenshtein and avoid storing multiple times the same conference.