Skip to content

toutpuissantged/SlimTik

Repository files navigation

SlimTik

What's this ?

slimtik is a simple, fast and powerful text editor.

Usage for developers without nodejs

installer python 3.x puis cloner le projet sur github apres avoir installer git en local

gitclone https://github.com/toutpuissantged/BestOfWeb.git

acceder au repertoire du projet

cd BOW

installer les dependances avec pip

pip install -r requirements.txt

lancer le script

python main.py

cette procedure est destiner au developeurs souhaitant tester rapidement le project , pour installer les usage de tests integrales veillez voir le chapitre suivant

usage for developers with nodejs

installer nodejs installer python 3.x puis cloner le projet sur github apres avoir installer git en local

gitclone https://github.com/toutpuissantged/BestOfWeb.git

acceder au repertoire du projet

cd BOW

installer les dependances avec pip

pip install -r requirements.txt

installer les dependances npm

npm install

pour lancer le developement avec du rechargement automatique

npm run dev

pour lancer les tests unitaires

npm run test

pour lancer la compilation du projet

npm run build

Contribution

pour contribuer au projet , vous pouvez suivre les instructions suivantes

forker le projet sur github

creer une branche pour votre contribution faite vos modifications sur votre branche une fois les commits creer un pull request et attendre la validation de l'administrateur

attention

  • les messages commits doivent etre explicites et en anglais pour eviter les confusions
  • les tests untaire et dintegration doivent etre valider par le serveur d'integration continue
  • ecrire des tests pour chaque fonctionnalite implementer
  • suivre les regle du code et respecter les standards

License

[MIT] (https://choosealicense.com/licenses/mit/)