README.md

POPCORN 🍿

Popcorn est une plateforme open source et (vraiment) sans commission qui aide les développeur-e-s freelance de Nantes à trouver des projets Voir le site

Les objectifs de Popcorn pour les développeurs freelances :

• 📈 Devenir un canal pour trouver des affaires à Nantes sans commission ni intermédiaire.
• 📗 Open source : on maîtrise les fonctionnalités de la plateforme, tel que les résultats de recherche, les informations affichées par nos profils etc
• 💬 Faire circuler les tuyaux boulot entre freelances via le tchat.

Créer son profil

• Fork ce dépôt
• Ajoute ta fiche dans le dossier content/persons en prenant comme exemple le fichier _exemple.md. Le nom de ton fichier sera utilisé pour créer l'url de ton profil.
• Ajoute ta photo dans le dossier /static/images : la photo doit faire 100ko maximum ⚠️
• Fait une pull request avec pour titre Nouveau profil : {ton prénom} .
• Bienvenue sur Popcorn ! ✨ Tu recevras également un mail pour t'inviter sur le tchat de Popcorn.

Pour soumettre une suggestion, signaler un bug, demander de l'aide, tu peux aussi tout simplement ouvrir une issue sur ce repo

FAQ

Quelle est la différence avec des plateformes comme Malt ou Comet ?

• Popcorn est une association à but non-lucratif et ne prélève pas de commission.
• Popcorn est réservé aux développeur·e·s de la région nantaise.
• Popcorn est développé et maintenu par les développeur(e)s freelances eux-mêmes.
• Popcorn n'est pas un intermédiaire ou une entreprise: les clients entrent directement en contact avec les freelances. Popcorn ne joue aucun rôle dans les échanges qui suivent ensuite entre les deux parties.

Documentation technique

Il s'agit d'une site généré statiquement avec Nuxt. Le répertoire content contient les fichiers markdown qui servent à produire les profils et les contenus du site. Ils sont transformés en fichiers JSON dans le dossier /static/api/ par le module Nuxt Gustave. Ce sont ces fichiers JSON qui sont ensuite consommés par les composants Vue.js, via un simple import webpack. Le tout est ensuite exporté en html via la commande npm run generate et hébergé sur un dépôt github.

Pourquoi un site statique (serverless) ?

L'idée expérimentée par Popcorn est d'avoir un site aussi léger techniquement que possible, sans serveur et base de données, afin qu'il ne requiert quasiment aucune maintenance et intervention de notre part, parce que :

• On est déjà tous "sous l'eau", ce site ne doit pas être une charge de travail supplémentaire.
• On ne veut pas que le site reste 48 heures en rade parce qu'il ya un truc qui déconne et que tout le monde est trop occupé pour intervenir dessus.
• On ne veut pas qu'au fil du temps une personne devienne "responsable" du site, qu'elle soit la seule à piger comment tout fonctionne et qu'elle parte à Barcelone ou quitte Popcorn en laissant aux autres un truc compliqué qu'ils et elles ne maitrisent pas
• On veut bien être hébergé pour 0 euros chez Github ^^
• On veut bien un site qui soit capable de supporter un fort pic de charge sans broncher : évitons le cas du site qui tombe pile au moment où un article de presse le mentionne 😅
• On veut bien un moteur de recherche super-rapide et un site qui s'affiche super vite
• On veut bien que des gens puissent tout simplement forker ce dépôt pour créer leur propre annuaire 💚

Installation

cloner ce dépôt, copier le fichier .env.example pour créer un fichier .env. Renseigner ce fichier puis :

npm install

démarrer le serveur de dev

npm run dev

Parser les markdowns du dossier content en fichiers JSON.

npx nuxt-gustave

Générer la version statique du site

npm run generate

Déployer

./deploy.sh