Getting Started

Escuela Fácil

Copy page

Installation

Code
 
$ npm install / yarn

Features

Documentation

Documentation of Escuela Facil

Generate

To generate modules you must execute the following command

Code
 
yarn create-feature <MODULE_NAME> 

If the module name is made up of two words, you must use a hyphen to separate the words. You must use "user-profile", do not use "userProfile" or "UserProfile".

Example

Code
 
$ yarn create-feature logo

Migration

Generate

Directory should be full path, example:

src/migrations/{nameMigration}

Code
 
$ yarn db:generate <directory>

Run

Code
 
$ yarn db:migrate

Running the app

Code
 
# development
$ npm run start / yarn run start

# watch mode
$ npm run start:dev / yarn run start:dev

# production mode
$ npm run start:prod / yarn run start:prod

Test

Code
 
# unit tests
$ npm run test / yarn run test

# e2e tests
$ npm run test:e2e / yarn run test:e2e

# test coverage
$ npm run test:cov / yarn run test:cov

Branches

• Master: Prouction branch
• Staging: Testing branch. Used by QA and client to test the app
• Development: Development branch used by devs to work on new features. Always create a new feature branch from here.

Naming convention

Always use kebab-case when naming branches. Name format for feature branches: {project-shorthand}-{ticket-number}/{type}/{description}.
Example: GC-56/fix/drawer-wont-open

Possible types:

• build: Create project from scratch
• feat: A new feature
• fix: A bug fix
• docs: Documentation only changes
• style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
• refactor: A code change that neither fixes a bug nor adds a feature
• perf: A code change that improves performance
• test: Adding missing or correcting existing tests
• chore: Changes to the build process or auxiliary tools and libraries such as documentation generation

Merge Requests

Use commitizen to format commits in order to have a unified commit template to fill in.

• npm i -g commitizen

• Use git cz instead of git commit

• Follow the walkthrough and add the relevant information always including the ticket number with it's project shorthand for proper linking to Jira ticket, e.g. GC-56

Rebase

We use fast forward method for Merge Requests, hence we need to rebase to be able to merge the feature branch into the destination branch (development in most cases)

• On feature branch
• git pull origin development:development
• git rebase origin/development
• if conflicts, solve them and then git rebase --continue (do this until there are no more conflicts)
• git push -f