Skip to content

Commit

Permalink
Merge pull request #1 from Yung-Beef/patch-1
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
olehmell authored Dec 20, 2022
2 parents d86c1b9 + cdfbbbb commit d22893e
Showing 1 changed file with 11 additions and 9 deletions.
20 changes: 11 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,29 @@
## Subsocial Starter

The starter of your social web3 journey.
The start of your Web3 social journey.

The starter is the foundational layer for using [Subsocial JS SDK](https://github.com/dappforce/subsocial-js) in a React app.
The starter is the foundational layer for using the [Subsocial JS SDK](https://github.com/dappforce/subsocial-js) in a React app.

It provides you with all set of methods, APIs, connections, etc. that you might need while writing your favourite social finance web app for your users.
It provides you with all set of methods, APIs, connections, etc. that you might need while building viral social web apps for your users.

Getting started is easy, just follow the steps:

### Creating a new project using starter

### Creating a new starter project
- Run the command:
```tsx
npx create-react-app my-app --template subsocial-starter
```

### Running the project
- Change directory to `my-app`
- Run command `yarn` to install all packages
- Run command `yarn start` to run the local project
- Change the directory to `my-app`
- Run the command `yarn` to install all of the packages
- Run the command `yarn start` to start the local project
- Congratulations, now your first Subsocial App is up and running.

Open the `my-app` directory, in a text-editor like VS Code or IDE and start building your favourite decenteralized social network. Read the comments inside the project for help.
Congratulations, now your first Subsocial App is up and running

Open the `my-app` directory in a code-editor like VS Code or IDE and start building your favourite decenteralized social network.
Read the comments inside of the project for help.

Other helpful resources:

Expand Down

0 comments on commit d22893e

Please sign in to comment.