Sylk Head First
Let's discover sylk CLI in less than 5 minutes.
Get started by installing the CLI using
pip install sylk
The command also installs all necessary dependencies you need to run sylk CLI.
What you'll need
Depeneds on your project requirements and or organization but you should setup your dev environment with the tools and languages you want to develop your
- Node.js version 16.14 or above:
- When installing Node.js, you are recommended to check all checkboxes related to dependencies.
- Go version 1.19 or above
- Python version 3.7 or above
Generate a new project
Generate a new
sylk site using the basic template.
The basic template will automatically be added to your project after you run the command:
sylk new my-app
You can pull a published project via the same
sylk new command by adding
sylk new my-cloud-app --project-id <your-cloud-project-id>
See more information on Platform Docs
You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor.
Start your application
Run the development server:
sylk run --build
cd command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there.
sylk run --build command builds your website locally and serves it through a development server, ready for you to send request at localhost:44880.
Start adding server resources such as new
Services which holds your business logic and implemantations (
Messages under packages and
Methods under services). Learn more on expanding your application with additional resources or see our full templates lists which can be handy to bootstrap your applications.