A small teaser of what you will have build in a couple of minutes from now:
- Cloning an example repository with a simple front-end project (a chat app)
- Syncano CLI installation
- Signing up and creating a Syncano project
- Installing a Syncano Socket
- Configuring the front-end
- Deploying your application to the cloud
You can test the app live at this url: https://production--chat-app.syncano.site/
Clone the example repository
First git clone the sample Chat project by going to your terminal application and running:
git clone https://github.com/Syncano-Community/chat-app.gitcd chat-app
Install the Syncano CLI
In order to use the Syncano CLI you will have to install the following dependencies:
syncano-cli is the main tool for setting up and managing your projects on the Syncano Platform. To install it, run:
npm install -g syncano-cli
Sign up and create a project
Once the Syncano CLI is installed you can sign up for an account. Run the following command in the root directory of your project:
You'll be asked for an
password so that we can create an account for you.
You'll also be prompted for a project template. Choose the recommended
Hello World template and press enter.
Install a Syncano Socket
Now, we will install the
chat socket from the
Sockets are modules that enclose a piece of functionality needed for your app. The difference is, that instead of functions they expose endpoints for communication with the server, and emit events so that integrations with other sockets are possible. You can find out more about the Sockets concept in the Sockets Overview section.
syncano-cli add chat
This command will add a
chat Socket as a dependency of your project. It has everything that is needed for your chat application front-end to work. By now your
chat-app project structure should look like this:
syncano-cli list chatto view the Socket documentation
To make sure it has been added correctly, you can open the
/chat-app/syncano/syncano.yml and see if these lines are present:
The chat app Socket you installed may have a higher version number
Configure your front-end
The only change you need to make in the code is in the
./web/index.html file. Open it and replace the
INSTANCE_NAME with your
Instance name in the 8th line:
To find out your Instance name you can run
syncano-clicommand. It will be printed as a
Deploy your project
Now it's time to deploy your app. To do this, run the following command:
syncano-cli hosting add ./web
Choose the defaults when prompted and type
y and press enter when asked
Do you want to sync files now?
Your web assets will be published under the url printed by the Syncano CLI. It should have this format:
https://staging--<instance name>.syncano.site/. Go to this url to see the published project. Open the url in two tabs to experience the realtime in action.
Ok, but What has just happened!?
You have successfully configured and deployed a full stack, realtime chat application. Well done!
How did it happen? Here's a quick rundown:
- When running
syncano-cli add chatyou have connected to
Syncano Registrywhich contains components that you can integrate into your app. Run
syncano-cli search [term]to discover more Sockets.
chatSocket was added as a dependency in the
syncano.ymlfile. All the dependencies installed from the
Syncano Registrywill be present in this file
- By providing the
index.htmlyou simply configure your web app to use your API. The
Syncano Clientlibrary handles the rest.
- When running
syncano-cli deploy chat, you tell Syncano to read from the
socket.ymlspec and, based on it, build your own API endpoints. The endpoints are available for use instantly after the
deploycommand is finished. To keep your local changes in sync with the Instance during development you can use the
syncano-cli deploy --hot [socket-name]command
syncano-cli hosting addis the last command. It publishes your static web assets from the
webfolder and hosts them on Syncano.
it! If you have any questions, log into our Slack and chat with the community. Happy coding!