Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updating quickstart #278

Merged
merged 11 commits into from
Oct 25, 2018
5 changes: 4 additions & 1 deletion docs/cheatsheet/web/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -492,7 +492,7 @@ <h4>Initiate project</h4>

# init with given instance nam
s init -i <new_or_existing_instance></code></pre>
<h4>Login to/register Syncano account</h4>
<h4>Login to Syncano account</h4>
<pre><code class="lang-bash">npx s login</code></pre>
<h4>Logout (delete account keys from this computer)</h4>
<pre><code class="lang-bash">npx s logout</code></pre>
Expand Down Expand Up @@ -559,6 +559,7 @@ <h4>Change single configuration option</h4>
<pre><code class="lang-bash">npx s config-set &lt;socket name&gt; &lt;option name&gt; &lt;value&gt;</code></pre>
</section>
<section data-tag="cli" class="c-column">
<<<<<<< HEAD
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Still conflicts here.

<h3>Registry</h3>

<h4>Search for Sockets</h4>
Expand All @@ -572,6 +573,8 @@ <h4>Submit your Socket to the registry</h4>

<h4>Make you private Socket public</h4>
<pre><code class="lang-bash">npx s publish &lt;socket name&gt;</code></pre>
=======
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

...and here.

>>>>>>> parent of c0d956a... chore(docs): remove registry

<h3>Hosting</h3>

Expand Down
40 changes: 39 additions & 1 deletion docs/docs/getting-started/quickstart.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,35 @@
# Quickstart Guide

To start using Syncano with your project follow the steps:
If you create **new project**, before start using Syncano, you should follow these steps:

## Create folder to your project

```sh
mkdir ~/my-project
```

and go to the created folder:

```sh
cd ~/my-project
```

## Install npm - package manager for JavaScript

```sh
npm install
```

## Inicialize empty project

```sh
npm init
```
You'll be asked for an `package name`, `version` , `description` , `git repository` , `keywords` , `author` and `license`.
You can use `npm init -y` command and press enter. The values will be accepted as default.

<br />
To start using Syncano in **your project** follow these steps:

## Install the Syncano CLI in your project

Expand Down Expand Up @@ -42,3 +71,12 @@ npx s list
Try to call endpoints using browser or any HTTP Client.

That's `it`! If you have any questions, log into our [Slack](https://syncano.io/#/slack-invite) and chat with the community. Happy coding!


## How to check the correctness of the socket?

After the URL address add args from your socket: `?$firstname=your_name&lastname=your_last_name` and press enter:

```sh
https://rough-star-5685.syncano.space/hello/hello/?$firstname=your_name&lastname=your_last_name
```