Nicolai Ort
161feaf364
continuous-integration/drone/pr Build is passing
Details
continuous-integration/drone/push Build is failing
Details
Reviewed-on: #121 |
||
---|---|---|
.vscode | ||
scripts | ||
src | ||
.dockerignore | ||
.drone.yml | ||
.env.ci | ||
.env.example | ||
.gitignore | ||
CHANGELOG.md | ||
Dockerfile | ||
LICENSE | ||
README.md | ||
docker-compose.yml | ||
jest.config.js | ||
licenses.md | ||
ormconfig.js | ||
package.json | ||
tmp.json | ||
tsconfig.json |
README.md
@lfk/backend
Backend Server
Quickstart 🐳
Use this to run the backend with a postgresql db in docker
- Clone the repo or copy the docker-compose
- Run in toe folder that contains the docker-compose file:
docker-compose up -d
- Visit http://127.0.0.1:4010/api/docs to check if the server is running
- You can now use the default admin user (
demo:demo
)
Dev Setup 🛠
Local dev setup utilizing sqlite3 as the database.
- Rename the .env.example file to .env (you can adjust app port and other settings, if needed)
- Install Dependencies
yarn
- Start the server
yarn dev
Run Tests
# Run tests once (server has to run)
yarn test
# Run test in watch mode (reruns on change)
yarn test:watch
# Run test in ci mode (automaticly starts the dev server)
yarn test:ci
Generate Docs
yarn docs
Recommended Editor
Recommended Extensions
- will be automatically recommended via ./vscode/extensions.json
Staging
Branches & Tags
- vX.Y.Z: Release tags created from the main branch
- The version numbers follow the semver standard
- A new release tag automaticly triggers the release ci pipeline
- main: Protected "release" branch
- The latest tag of the docker image get's build from this
- New releases get created as tags from this
- dev: Current dev branch for merging the different feature branches and bugfixes
- The dev tag of the docker image get's build from this
- Only push minor changes to this branch!
- To merge a feature branch into this please create a pull request
- feature/xyz: Feature branches - nameing scheme:
feature/issueid-title
- bugfix/xyz: Branches for bugfixes - nameing scheme:
bugfix/issueid-title