update dev doc, add doc links in settings dialog

Signed-off-by: Julien Veyssier <eneiluj@posteo.net>
This commit is contained in:
Julien Veyssier
2021-07-29 21:30:46 +02:00
parent 62a5e8f9bc
commit cc5c5e2e11
2 changed files with 61 additions and 2 deletions

View File

@@ -1,12 +1,22 @@
# Development environment
Clone this repository and run:
Clone this repository and build:
``` bash
npm install
cd /var/www/.../nextcloud/apps
git clone https://github.com/eneiluj/cospend-nc cospend
cd cospend
npm ci
npm run watch
```
Or if you want to use HMR (hot module replacement),
install the [Nextcloud HMR Enabler app](https://github.com/nextcloud/hmr_enabler)
and run this in cospend directory:
``` bash
npm run serve
```
# Public API
Plan was to make Cospend public API strictly identical to [IHateMoney API](https://ihatemoney.readthedocs.io/en/latest/api.html) but there is a restriction i couldn't bypass : the authentication system. IHateMoney uses the basic HTTP authentication, just like Nextcloud user authentication. So, to get a guest access to a Cospend project, this type of authentication was first rejected by Nextcloud user auth system and then accepted by Cospend with a huge latency.

View File

@@ -30,6 +30,51 @@
<h3 class="app-settings-section__hint">
{{ t('cospend', 'Thanks for using Cospend') + ' ♥' }}
</h3>
<h3 class="app-settings-section__hint">
{{ t('cospend', 'Bug/issue tracker') + ': ' }}
</h3>
<a href="https://github.com/eneiluj/cospend-nc/issues"
target="_blank"
class="external">
https://github.com/eneiluj/cospend-nc/issues
<span class="icon icon-external" />
</a>
<h3 class="app-settings-section__hint">
{{ t('cospend', 'Translation') + ': ' }}
</h3>
<a href="https://crowdin.com/project/moneybuster"
target="_blank"
class="external">
https://crowdin.com/project/moneybuster
<span class="icon icon-external" />
</a>
<h3 class="app-settings-section__hint">
{{ t('cospend', 'User documentation') + ': ' }}
</h3>
<a href="https://github.com/eneiluj/cospend-nc/blob/master/docs/user.md"
target="_blank"
class="external">
https://github.com/eneiluj/cospend-nc/blob/master/docs/user.md
<span class="icon icon-external" />
</a>
<h3 class="app-settings-section__hint">
{{ t('cospend', 'Admin documentation') + ': ' }}
</h3>
<a href="https://github.com/eneiluj/cospend-nc/blob/master/docs/admin.md"
target="_blank"
class="external">
https://github.com/eneiluj/cospend-nc/blob/master/docs/admin.md
<span class="icon icon-external" />
</a>
<h3 class="app-settings-section__hint">
{{ t('cospend', 'Developer documentation') + ': ' }}
</h3>
<a href="https://github.com/eneiluj/cospend-nc/blob/master/docs/dev.md"
target="_blank"
class="external">
https://github.com/eneiluj/cospend-nc/blob/master/docs/dev.md
<span class="icon icon-external" />
</a>
</AppSettingsSection>
<AppSettingsSection v-if="!pageIsPublic"
:title="t('spreed', 'Import projects')"
@@ -274,6 +319,10 @@ export default {
</script>
<style lang="scss" scoped>
a span.icon {
display: inline-block;
margin-bottom: -3px;
}
.wrapper {
overflow-y: scroll;