update readme.md

This commit is contained in:
2023-01-22 11:52:53 +01:00
parent de2c0849f7
commit 0c4f3295ac

View File

@@ -1,43 +1,24 @@
# README # # README #
**cao_blogr** is mini app for blogging developed with the Pyramid framework **cao_blogr** est une application pour créer un blog simple. Elle est inspirée du tutorial [**pyramid_blogr**](https://docs.pylonsproject.org/projects/pyramid-blogr/en/latest/index.html).
## How do I get set up? ## ## Fonctionnalités ##
- Change directory into your newly created Pyramid project. - Gestion des utilisateurs du blog (admin ou rédacteur)
- Authentification et autorisation des utilisateurs
- Gestion des posts du blog avec des statuts : *publié, brouillon ou privé*
- Gestion des tags (un post peut avoir un tag)
- Les posts sont rédigé avec le langage *Markdown*
- Possibilité de faire des recherches sur le titre et le corps des posts
` cd cao_blogr ` ## Add-on requis ##
- Create a Python virtual environment. - Python 3.7.1
- Pyramid 1.10
- SQLite 3.35.5
- pyramid-jinja2 2.7 : view templating
- wtforms 2.2.1 : form library
- webhelpers2 2.0 : various web building related helpers
- Markdown 3.4.1 :
`python3 -m venv env `
- Upgrade packaging tools.
`env/bin/pip install --upgrade pip setuptools `
- Install the project in editable mode with its testing requirements.
` env/bin/pip install -e ".[testing]" `
- Initialize and upgrade the database using Alembic.
- Generate your first revision.
`env/bin/alembic -c development.ini revision --autogenerate -m "init" `
- Upgrade to that revision.
`env/bin/alembic -c development.ini upgrade head `
- Load default data into the database using a script.
` env/bin/initialize_cao_blogr_db development.ini `
- Run your project's tests.
` env/bin/pytest `
- Run your project.
`env/bin/pserve development.ini `