Skip to content

Commit

Permalink
Removed deploy script and updated readme (#2)
Browse files Browse the repository at this point in the history
* removed deploy script (since we've migrated to docker deployment)

* updated readme
  • Loading branch information
HetorusNL authored Aug 25, 2023
1 parent bb8c519 commit 37a72ff
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 35 deletions.
20 changes: 14 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
# Vocya - vocabulary shop

Front-end for the vocjem data; dashboard and API.
Both the dashboard and API are available as docker containers:

- https://hub.docker.com/r/hetorusnl/vocya-api
- https://hub.docker.com/r/hetorusnl/vocya-dashboard

## API

Expand All @@ -10,6 +14,8 @@ The current API endpoint can be reached at: https://api.vocya.hetorus.nl/.

### Running the API

Either run the API using the docker container mentioned above, or manually using the steps below.

Install poetry: https://python-poetry.org/docs/

Ensure poetry works by running:
Expand Down Expand Up @@ -41,6 +47,8 @@ Query words with course='jem1' chapter='jem1-1' and id='jem1-1'
https://api.vocya.hetorus.nl/course/jem1/chapter/jem1-1/word/jem1-1
Searching is no longer supported on the API side, searching within returned words for a course/chapter/all should be performed client-side.

\*change the domain name when running the API locally

## Dashboard

The front-end dashboard of vocya showing the results of the API calls to the vocya API.
Expand All @@ -51,6 +59,10 @@ When clicking on the results, a single result page is opened where the 'raw prop
If this is enabled, only these specific fields (equivalent fields for courses and chapters) are searched instead of every field (including id, chapter, chapter_name, etc) by issuing a 'wildcard search'.
The current dashboard is hosted at: https://vocya.hetorus.nl

### Running the Dashboard

Either run the Dashboard using the docker container mentioned above, or manually using the steps/scripts below.

### Configuring yarn

```bash
Expand Down Expand Up @@ -90,6 +102,8 @@ this updates the version number (if changed in `package.json`) and builds the ap

### Run a build with version increment and git commit creation

// TODO: tagging is not yet working with the squash pull-request way, and not yet available in the github actions workflows

the Semantic Versioning, also known as "semver", is used:
version: `major.minor.patch`
run one of the following commands:
Expand All @@ -100,12 +114,6 @@ all these three commands also create a git commit and git tag with the message:
`v${npm_package_version}` (which is the major.minor.patch version)
these three commands also perform a push to the master branch on github and push the tags

### Deploy the newly generated version to the server

run the following command to deploy the new version:
`yarn deploy`
this removes the previous build from the server and copies the build to the server

## License

MIT License, Copyright (c) 2023 Tim Klein Nijenhuis <tim@hetorus.nl>
27 changes: 0 additions & 27 deletions dashboard/deploy.sh

This file was deleted.

3 changes: 1 addition & 2 deletions dashboard/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,7 @@
"release-minor": "yarn version minor && yarn postversion",
"release-major": "yarn version major && yarn postversion",
"postversion": "yarn build && yarn git-script",
"git-script": "node git-script",
"deploy": "./deploy.sh"
"git-script": "node git-script"
},
"eslintConfig": {
"extends": [
Expand Down

0 comments on commit 37a72ff

Please sign in to comment.