You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
François Poulain c4a7cde525 Merge pull request 'fix(users): supprime du formulaire les champs obsoletes; fix #5' (#6) from fpoulain/services_pour_tous:main into main 1 month ago
assets feat(assets): ajoute un premier jet de style 6 months ago
requirements feat(deps): ajoute wagtail-cblocks 7 months ago
services_pour_tous fix(users): supprime du formulaire les champs obsoletes; fix #5 1 month ago
styleguide feat(assets): ajoute un premier jet de style 6 months ago
.babelrc Initialisation depuis le cookiecutter 7 months ago
.browserslistrc Initialisation depuis le cookiecutter 7 months ago
.editorconfig Initialisation depuis le cookiecutter 7 months ago
.eslintrc.json Initialisation depuis le cookiecutter 7 months ago
.gitattributes Initialisation depuis le cookiecutter 7 months ago
.gitignore feat(git): ajoute le fichier de tags à gitignore 7 months ago
.stylelintrc Initialisation depuis le cookiecutter 7 months ago
CHANGELOG.md doc(CHANGELOG): publie la v0.4.0 6 months ago
CONTRIBUTORS.txt Initialisation depuis le cookiecutter 7 months ago
LICENSE Initialisation depuis le cookiecutter 7 months ago
Makefile doc(release): documente la release 7 months ago
README.md doc(release): corrige la documentation de release 7 months ago
config.env.example Initialisation depuis le cookiecutter 7 months ago
gulpfile.js feat(fonts): ajoute la fonte open sans 7 months ago
manage.py Initialisation depuis le cookiecutter 7 months ago
package.json feat(fonts): ajoute la fonte open sans 7 months ago
pyproject.toml Initialisation depuis le cookiecutter 7 months ago
requirements.txt Initialisation depuis le cookiecutter 7 months ago
setup.cfg Initialisation depuis le cookiecutter 7 months ago

README.md

Services pour tous

Plateforme de promotion de services

Table of content

Give a try

On a Debian-based host - running at least Debian Stretch:

$ sudo apt install python3 virtualenv git make
$ git clone https://forge.cliss21.org/cliss21/services_pour_tous
$ cd services_pour_tous/

$ make init
# A configuration file will be created interactively; you can uncomment:
#  ENV=development

$ make serve

Then visit http://127.0.0.1:8000/ in your web browser.

Installation

Requirements

On a Debian-based host - running at least Debian Stretch, you will need the following packages:

  • python3
  • virtualenv
  • make
  • git (recommended for getting the source)
  • python3-mysqldb (optional, in case of a MySQL / MariaDB database)
  • python3-psycopg2 (optional, in case of a PostgreSQL database)

Quick start

It assumes that you already have the application source code locally - the best way is by cloning this repository - and that you are in this folder.

  1. Define your local configuration in a file named config.env, which can be copied from config.env.example and edited to suits your needs.

    Depending on your environment, you will have to create your database and the user at first.

  2. Run make init.

    Note that if there is no config.env file, it will be created interactively.

That's it! Your environment is now initialized with the application installed. To update it, once the source code is checked out, simply run make update.

You can also check that your application is well configured by running make check.

Deployment

Web application

Here is an example deployment using NGINX - as the Web server - and uWSGI - as the application server.

uWSGI

The uWSGI configuration doesn't require a special configuration, except that we are using Python 3 and a virtual environment. Note that if you serve the application on a sub-location, you will have to add route-run = fixpathinfo: to your uWSGI configuration (available since v2.0.11).

NGINX

In the server block of your NGINX configuration, add the following blocks and set the path to your application instance and to the uWSGI socket:

location / {
    include uwsgi_params;
    uwsgi_pass unix:<uwsgi_socket_path>;
}
location /media {
    alias <app_instance_path>/var/media;
}
location /static {
    alias <app_instance_path>/var/static;
    # Optional: don't log access to assets
    access_log off;
}
location = /favicon.ico {
    alias <app_instance_path>/var/static/favicon/favicon.ico;
    # Optional: don't log access to the favicon
    access_log off;
}

Structure

Overview

All the application files - e.g. Django code including settings, templates and statics - are located into services_pour_tous/.

Two environments are defined - either for requirements and settings:

  • development: for local application development and testing. It uses a SQLite3 database and enable debugging by default, add some useful settings and applications for development purpose - i.e. the django-debug-toolbar.
  • production: for production. It checks that configuration is set and correct, try to optimize performances and enforce some settings - i.e. HTTPS related ones.

Local changes

You can override and extend statics and templates locally. This can be useful if you have to change the logo for a specific instance for example. For that, just put your files under the local/static/ and local/templates/ folders.

Regarding the statics, do not forget to collect them after that. Note also that the local/ folder is ignored by git.

Variable content

All the variable content - e.g. user-uploaded media, collected statics - are stored inside the var/ folder. It is also ignored by git as it's specific to each application installation.

So, you will have to configure your Web server to serve the var/media/ and var/static/ folders, which should point to /media/ and /static/, respectively.

Development

The easiest way to deploy a development environment is by using the Makefile.

Before running make init, ensure that you have either set ENV=development in the config.env file or have this environment variable. Note that you can still change this variable later and run make init again.

There is some additional rules when developing, which are mainly wrappers for manage.py. You can list all of them by running make help. Here are the main ones:

  • make serve: run a development server
  • make test: test the whole application
  • make lint: check the Python code syntax

Assets

The assets - e.g. CSS, JavaScript, images, fonts - are generated using a Gulp-powered build system with these features:

  • SCSS compilation and prefixing
  • JavaScript module bundling with webpack
  • Styleguide and components preview
  • Built-in BrowserSync server
  • Compression for production builds

The source files live in assets/, and the styleguide in styleguide/.

Requirements

All you need is npm. It is included in Debian since Buster and also in the stretch-backports repository.

Usage

Start by installing the application dependencies - which are defined in package.json - by running: npm install.

The following tasks are then available:

  • npm run build: build all the assets for development and production use, and put them in the static folder - e.g services_pour_tous/static.
  • npm run styleguide: run a server with the styleguide and watch for file changes.
  • npm run serve: run a proxy server to the app - which must already be served on localhost:8000 - with the styleguide on /styleguide and watch for file changes.
  • npm run lint: lint the JavaScript and the SCSS code.

In production, only the static files will be used. It is recommended to commit the compiled assets just before a new release only. This will prevent to have a growing repository due to the minified files.

Release

Before releasing one should verify that make test and make lint are ok. Migrations should also have been added during development process.

Hygienic checklist

    make test
    make lint
    npm run lint
    make check-migrations
    git grep '\<print\s*(\|pdb\>\|\<set_trace\>' '*.py'

Release gitmnastic

  1. Define variables

     export VERSION="x.y.z"     # version to be released
     export ORIGIN="origin"     # remote name for pushing my origin
     export UPSTREAM="cliss21"  # remote name for pushing upstream
     export GITEA_USER="jdoe"   # my forge username
    
  2. Fork from the develop branch:

     git checkout -b release_$VERSION
    
  3. Build and commit statics

     npm run build
     git add -f services_pour_tous/static
     git commit -m "build($VERSION): ajoute les statics compilés"
    
  4. Update services_pour_tous/__init__.py and complete changelog via:

     make release
    
  5. Edit and commit it

     /usr/bin/editor CHANGELOG.md
     git add services_pour_tous/__init__.py CHANGELOG.md
     git commit -m "doc(CHANGELOG): publie la v$VERSION"
    
  6. Tag your release commit

     git tag v$VERSION
    
  7. Merge it in main

     git push --set-upstream $ORIGIN release_$VERSION
     git push --tags
     # then open a PR via
     xdg-open "https://forge.cliss21.org/cliss21/services_pour_tous/compare/main...$GITEA_USER:release_$VERSION"
     # then get the PR merged
     git push --tags $UPSTREAM
    

That's released. Now we prepare repo for a new develop sprint

  1. Rebase develop on main

     git fetch --all
     git checkout develop
     git rebase $UPSTREAM/main
    
  2. Revert statics from develop

     git revert $(git rev-list --all --max-count=1 services_pour_tous/static/)
     git push $ORIGIN
     # then open a PR or not
     xdg-open "https://forge.cliss21.org/cliss21/services_pour_tous/compare/develop...$GITEA_USER:develop"
     # then get the PR merged (or directly push via git push $UPSTREAM)
    
  3. You should be ready for a new develop sprint

     git fetch --all
    

License

Services pour tous is developed by Cliss XXI and licensed under the AGPLv3+.

Map all the world