General convention for branches names are: <feature_name>-<user_name>
.
Feature names are given by Administrator. In the future, feature names will be taken from GitHub issues or project.
master
branch is protected by default. All pull requests have to be accepted by Administrator.
There are no restrictions in terms of commmit messages. However, please do not use "." or "next" as commit message. Message should describe briefly what was done.
<name>.<type>.ts
, eg.: add-user.input.ts
.src/modules
.src/utils
.common
module.server
project.server
project.@Inject()
before injected services.@Decorators
, eg. prop()
from @typegoose/typegoose
should be imported as Property
. Change the names of imports to unique.Backend is written using TypeScript with NestJS and type-graphql.
Hosted on port 5000.
REMEMBER TO: Copy .env.template
into .env
and set proper values.
Frontend is written (will be) using React and Apollo Client.
Hosted on port 3000.
To run project in development mode use docker-compose up --build
.