mirror of
https://github.com/sp-tarkov/db-website.git
synced 2025-02-08 04:50:46 -05:00
docs: Update README and add postman collection
This commit is contained in:
parent
0a2b2872a4
commit
ed68e595d6
14
README.md
14
README.md
@ -1,10 +1,5 @@
|
|||||||
# SPT Items
|
# SPT Items
|
||||||
|
|
||||||
* You can use either of the two drone pipeline types:
|
|
||||||
* [docker](.drone-docker.yml)
|
|
||||||
* [kubernetes](.drone-kubernetes.yml)
|
|
||||||
* Some enhancement ideas can be found [here](#some-enhancement-ideas)
|
|
||||||
|
|
||||||
## Required secrets
|
## Required secrets
|
||||||
| secret name | description | example |
|
| secret name | description | example |
|
||||||
| :----------------- | :---------- | :------- |
|
| :----------------- | :---------- | :------- |
|
||||||
@ -30,7 +25,13 @@
|
|||||||
1. Nginx must be configured to use HTTPS
|
1. Nginx must be configured to use HTTPS
|
||||||
1. Nginx must be configured to listen to *spt_items_hostname* and to point to the *deploy_path*
|
1. Nginx must be configured to listen to *spt_items_hostname* and to point to the *deploy_path*
|
||||||
|
|
||||||
|
|
||||||
## The pipeline summary
|
## The pipeline summary
|
||||||
|
* You can use either of the two drone pipeline types:
|
||||||
|
* [docker](.drone-docker.yml)
|
||||||
|
* [kubernetes](.drone-kubernetes.yml)
|
||||||
|
* Some enhancement ideas can be found [here](#some-enhancement-ideas)
|
||||||
|
|
||||||
1. Each push will:
|
1. Each push will:
|
||||||
1. Test the frontend
|
1. Test the frontend
|
||||||
2. IF on `development` or `master`/`main` branch
|
2. IF on `development` or `master`/`main` branch
|
||||||
@ -45,3 +46,6 @@ see [Walkthrough.md](./docs/Walkthrough.md)
|
|||||||
## Some enhancement ideas
|
## Some enhancement ideas
|
||||||
- Store the build so that it is not rebuilt on any `promote` event
|
- Store the build so that it is not rebuilt on any `promote` event
|
||||||
- Use a volume or a cache for Yarn install
|
- Use a volume or a cache for Yarn install
|
||||||
|
|
||||||
|
## Thanks
|
||||||
|
- CWX
|
3255
docs/Singleplayer-Tarkov-Items.postman_collection.json
Normal file
3255
docs/Singleplayer-Tarkov-Items.postman_collection.json
Normal file
File diff suppressed because it is too large
Load Diff
Loading…
x
Reference in New Issue
Block a user