This repository is a small training on design patterns, this iteration is about the MVC design pattern.
The project comes with a front-end that you can access through : localhost:8000
Some features are presented but are not working yet: Thumbnails, Popular articles list, Likes, Tags, and SearchBar.
Working features: HomePage, Article list, CRUD for articles, Comments on articles and export articles on CSV and XLSX formats.
With docker:
Refer to Docker-Setup to install with docker.
Create your .env and .env.local file and add provider_key and provider_secret to your gmail application
Without docker:
If not, to run this project, you will need to install the following dependencies on your system:
On linux, if you have a permission denied error on mysql_data, run :
sudo chown -R <user>:<user> ./folder
You branch should have a name that reflects it's purpose.
It should use the same guidelines as COMMIT_CONVENTIONS (feat, fix, build, perf, docs), followed by an underscore (_) and a very quick summary of the subject in [kebab case][1].
Example: feat_add-image-tag-database-relation.
Pull requests in this project follow two conventions, you will need to use the templates available in the ISSUE_TEMPLATE folder :
- Adding a new feature should use the FEATURE_REQUEST template.
- Reporting a bug should use the BUG_REPORT template.
If your pull request is still work in progress, please add "WIP: " (Work In Progress) in front of the title, therefor you inform the maintainers that your work is not done, and we can't merge it.
The naming of the PR should follow the same rules as the COMMIT_CONVENTIONS
Jason Gauvin |
Jacques Maarek |
Corto Dufour |
Edwin Vautier |