1
0
mirror of https://github.com/spacebarchat/docs.git synced 2024-11-22 02:02:32 +01:00

Add mention of dev client, fix typo

This commit is contained in:
bitfl0wer 2023-05-20 13:09:22 +02:00
parent ed5eb4cbd3
commit 82bf3f9ff5
No known key found for this signature in database
GPG Key ID: 84BBB60DF895ABF2

View File

@ -8,32 +8,38 @@ The official {{ project.name }} client is currently being developed at [this rep
## Official host
We currently host the client at [https://app.{{ project.domain }}](https://app.{{ project.domain }}).
You can use it to connect to our official instance by default,
or you can use it to connect to your own by editing your local storage to include the `routeSettings` key with the below example content:
The new, React-only client is being hosted at [https://dev.app.{{ project.domain }}](https://dev.app.{{ project.domain }}).
An older, React Native version of the client can be found at
[https://app.{{ project.domain }}](https://app.{{ project.domain }}).
You can use it to connect to our official instance by default, or you can use it to connect to your
own instance by editing your local storage to include the `routeSettings` key with the below example
content:
```json
{
"api": "https://staging.{{ project.domain }}/api/v9",
"cdn": "https://cdn.staging.{{ project.domain }}",
"gateway": "wss://gateway.staging.{{ project.domain }}",
"invite": "https://staging.{{ project.domain }}/invite",
"template": "https://staging.{{ project.domain }}/template",
"gift": "https://staging.{{ project.domain }}/gift",
"scheduledEvent": "https://staging.{{ project.domain }}/events"
"api": "https://staging.{{ project.domain }}/api/v9",
"cdn": "https://cdn.staging.{{ project.domain }}",
"gateway": "wss://gateway.staging.{{ project.domain }}",
"invite": "https://staging.{{ project.domain }}/invite",
"template": "https://staging.{{ project.domain }}/template",
"gift": "https://staging.{{ project.domain }}/gift",
"scheduledEvent": "https://staging.{{ project.domain }}/events"
}
```
Replace the above endpoints with your own. If your domain name is `https://whatever.notasite`, then you'll most likely want to enter
`https://whatever.noasite/api/v9` for the API endpoint, etc.
`https://whatever.notasite/api/v9` for the API endpoint, etc.
If you're using the React Native client, you can also edit these settings by visiting [https://app.{{ project.domain }}/settings](https://app.{{ project.domain }}/settings).
## Setup/Building
These Instructions refer to the old, React Native client, and therefore do not apply to the new, React-only client.
### Dependencies
- [Git](https://git-scm.com/)
- [NodeJS](https://nodejs.org). Version 16+
- [yarn](https://yarnpkg.com/) (preferred) or npm
- [Git](https://git-scm.com/)
- [NodeJS](https://nodejs.org). Version 16+
- [yarn](https://yarnpkg.com/) (preferred) or npm
In your terminal:
@ -86,13 +92,13 @@ Files will be built to `web-build`
To contribute:
- [Fork the repository]({{ repositories.base_url }}/{{ repositories.client }}/fork)
- Run the building instructions.
- Commit & Push.
- Pull Request & Done!
- [Fork the repository]({{ repositories.base_url }}/{{ repositories.client }}/fork)
- Run the building instructions.
- Commit & Push.
- Pull Request & Done!
### What can I contribute?
- "Core" features like settings, editing messages, dms, markdown rendering, etc. What do you think are basic features that you would want? Some of the GitHub Issues apply to this.
- Implementing other things like voice/video is fine too, though
- [This]({{ repositories.base_url }}/{{ repositories.client }}/issues/21) is a good starting point and lists the core features that are still missing from the client.
- "Core" features like settings, editing messages, dms, markdown rendering, etc. What do you think are basic features that you would want? Some of the GitHub Issues apply to this.
- Implementing other things like voice/video is fine too, though
- [This]({{ repositories.base_url }}/{{ repositories.client }}/issues/21) is a good starting point and lists the core features that are still missing from the client.