Starter Pack

Coding Environment

Most of people are coding in a VM in our office. You need to have an ssh key for it.

You can follow the tutorial section step by step to make your coding environment:

• Generate an ssh key

• Access Office from Outside by VPN

• Mount folder from remote VM to your local computer

This way you can be working on your computer in your favorite IDE, saving file and it will change in VM and hot reload to see your changes in real time.

Coding

Most of our project are using same technologies / tools.

Dependencies

• *NIX System (Unix / Linux, Posix, MacOS etc)
• docker
• docker-compose
• make

Steps to get a new project

• git clone $repo
• git checkout develop we aren't working on master branch, check gitflow !
• make init to init environment variables
• make to make the stack running on your computer (api + sql + phpmyadmin)
• make logs to see docker containers logs

API in development mode (make) will watch for changement and restart automatically (thanks to Nodemon)

React / React-Native / Preact already have tools to watch changements.

Commit message

Backend:

• ✨ :sparkles: add feature
• ♻️ :recycle: refactor code
• 🚑 :ambulance: hotfix
• 🔥 :fire: remove code or files
• 🎨 :art: improve structure / format of the code
• ⚡ :zap: improve performance
• ✅ :white_check_mark: add or update tests

Makefile

• make help to see every available commands
• make launch the project
• make logs logs of the project
• make clean stop the project

VS Code recommend extensions

• GitHub Copilot AI auto-complete code
• EditorConfig for VS Code easy to format code, if the project has .editorconfig
• Error Lens show the error at the end of the line
• Git Graph show project git graph
• ESLint helping you writing cleaner code
• Import Cost display size of imported package

Backend

• Thunder Client like Postman, can request API directly
• Doxygen Documentation Generator quickly to generate jsdoc
• Gitmoji add gitmoji to commit message

For more information, please check the coding style.