IT4Change/boilerplate-backend
3
0
Fork 0
mirror of https://github.com/IT4Change/boilerplate-backend.git synced 2025-12-13 10:25:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
Ulf Gebhardt 2023-12-12 08:57:28 +01:00
parent c91e9969d1
commit c2ecf88674
Signed by: ulfgebhardt
GPG Key ID: DA6B843E748679C9
1 changed files with 25 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -76,6 +76,31 @@ The following endpoints are provided given the right command is executed or all
| [http://localhost:4000/graphql](http://localhost:4000/graphql) | GraphQL API |
| [http://localhost:4000/playground](http://localhost:4000/playground) | GraphQL Playground |
## How to use as part of a project
If you want to use this as part of a larger project, e.g. in conjunction with a frontend also utilizing a boilerplate you cannot use the template mechanic provided by github for this repository.
You can use the following commands to include the whole git history of the boilerplate and be able to update according to changes to this repo using another remote.
```bash
git remote add xxx_boilerplate_backend git@github.com:IT4Change/boilerplate-backend.git
git fetch xxx_boilerplate_backend
git merge -s ours --no-commit --allow-unrelated-histories xxx_boilerplate_backend/master
git read-tree --prefix=xxx/ -u xxx_boilerplate_backend/master
git commit -m "Imported boilerplate_backend as a subtree under xxx/."
```
To update the subtree you can use
```bash
git subtree pull -P xxx/ xxx_boilerplate_backend master
git commit -m "Updated boilerplate_backend in subtree under xxx/."
```
Where `xxx` refers to the folder and product part you want to use the boilerplate in. This assumes that you might need several copies of the frontend boilerplate for you product.
This mechanic was taken from this [source](https://stackoverflow.com/questions/1683531/how-to-import-existing-git-repository-into-another/8396318#8396318)
## Database setup
The project is set up for a `sqlite` database.