Nicolai Ort
c9378e6cae
continuous-integration/drone/push Build is passing
Details
ref #59 |
||
---|---|---|
.vscode | ||
scripts | ||
src | ||
.dockerignore | ||
.drone.yml | ||
.env.ci | ||
.env.example | ||
.gitignore | ||
Dockerfile | ||
LICENSE | ||
README.md | ||
docker-compose.yml | ||
jest.config.js | ||
ormconfig.js | ||
package.json | ||
tsconfig.json |
README.md
@lfk/backend
Backend Server
Dev Setup 🛠
Local w/ sqlite
- Create a .env file in the project root containing:
APP_PORT=4010 DB_TYPE=sqlite DB_HOST=bla DB_PORT=bla DB_USER=bla DB_PASSWORD=bla DB_NAME=./test.sqlite
- Install Dependencies
yarn
- Start the server
yarn dev
Generate Docs
yarn docs
Docker w/ postgres 🐳
docker-compose up --build
Recommended Editor
Recommended Extensions
- will be automatically recommended via ./vscode/extensions.json
Branches
- main: Protected "release" branch
- dev: Current dev branch for merging the different features - only push for merges or minor changes!
- feature/xyz: Feature branches -
feature/issueid-title
- bugfix/xyz: Branches for bugfixes -
bugfix/issueid-title
(no id for readme changes needed)
File Structure
- src/models/entities* - database models (typeorm entities)
- src/models/actions* - actions models
- src/models/responses* - response models
- src/controllers/* - routing-controllers
- src/loaders/* - loaders for the different init steps of the api server
- src/middlewares/* - express middlewares (mainly auth r/n)
- src/errors/* - our custom (http) errors
- src/routes/* - express routes for everything we don't do via routing-controllers (depreciated)