Skip to content
/ mewvy Public

An example of a repository that implements good practice for a collaborative project

License

Notifications You must be signed in to change notification settings

3kezoh/mewvy

Repository files navigation

Mewvy

Contributor Covenant

GitHub license

Mewvy is a dummy project that aims to gather a maximum of good practices for a project, including minimal, clear and concise installation instructions.

Prerequisites

Installation

Clone this repository

# Gitlab (prefered)
git clone https://gitlab.com/iw-intensive-week-1-2021/groupe-10-iw3-4.git mewvy
# Github
git clone https://github.com/3kezoh/blog.git

Use docker-compose to bootstrap the project

docker-compose up --build

Deploy the database:

php artisan migrate

Insert random information into the database:

php artisan db:seed

Endpoints

Nom Endpoint Description
home / Génère une JSONResponse contenant deux films
time /time Génère une JSONResponse contenant le timestamp UNIX actuel

Good Practices

Authentication 🔒

You should really consider using SSH to interact securely with, which provides a secure channel over an insecure network. More informations

Verified commits ✅

Using a GPG key, you can locally sign commits and tags to enforce their authenticity.

Gitmoji is an initiative to standardize and explain the use of emojis on GitHub commit messages.

Example

  • ✨ Introduce new feature
  • 📄 Update LICENSE

Branch Naming conventions

Not using proper naming conventions causes confusion and makes it difficult for the code maintenance team to maintain the code.

Ypu can apply a simple and well known naming conventions

Example

  • master
  • feature, feature/google-oauth, feature/flex-component
  • release,
  • hotfix, hotfix/key-vulne

Mewvy has adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.

License

Mewvy is MIT Licensed

About

An example of a repository that implements good practice for a collaborative project

Resources

License

Stars

Watchers

Forks

Packages

No packages published