https://github.com/dappforce/subsocial-docs
Subsocial documentation.
https://github.com/dappforce/subsocial-docs
api-reference docs documentation polkadot subsocial substrate tutorials
Last synced: about 1 month ago
JSON representation
Subsocial documentation.
- Host: GitHub
- URL: https://github.com/dappforce/subsocial-docs
- Owner: dappforce
- Created: 2021-05-17T12:00:30.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-04-04T10:20:04.000Z (about 1 year ago)
- Last Synced: 2024-04-04T14:12:58.870Z (about 1 year ago)
- Topics: api-reference, docs, documentation, polkadot, subsocial, substrate, tutorials
- Language: JavaScript
- Homepage: https://docs.subsocial.network
- Size: 30.2 MB
- Stars: 0
- Watchers: 2
- Forks: 19
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Subsocial Docs
### Prerequisites
You need to have installed:
- [NodeJS](https://nodejs.org/uk/download/) >= 14.x
- [Yarn](https://classic.yarnpkg.com/en/docs/install/#debian-stable)
And then run:
```
$ yarn
```
This command fetches all required dependencies for this project.
### Local Development
```
$ yarn start
```
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
### Build
```
$ yarn build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
### Deployment
```
$ GIT_USER= USE_SSH=true yarn deploy
```
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
### CI/CD
#### Good to know:
- By default, CI [configured to deploy](.github/workflows/delpoy.yml) to [dappforce/dappforce.github.io](https://github.com/dappforce/dappforce.github.io).
- You have to [create the deployment key](https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-create-ssh-deploy-key) to be able to deploy to external repository.
- Public SSH key should be set up in the base deploy repository (in settings "Deploy keys" tab).
- Private SSH key should be set up in this exact repository (in settings "Secrets" tab).