Skip to content

Commit

Permalink
Fixed broken issues with document
Browse files Browse the repository at this point in the history
  • Loading branch information
JamieDawson committed Dec 16, 2020
1 parent 8d1221a commit 23547ed
Show file tree
Hide file tree
Showing 5 changed files with 109 additions and 16 deletions.
66 changes: 66 additions & 0 deletions docs/project-creating-your-own.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
---
id: nim-creating-project
title: Creating your project
sidebar_label: Creating your project
---

import useBaseUrl from '@docusaurus/useBaseUrl';

### Creating your project template with the Nimbella CLI

With the Nimbella CLI, you can create a project template that you can use to instantly start building your project.

To create a project template, run this command in your command prompt:

```
nim project create folder_name
```

After running this command in your command prompt, you should see a message saying your project folder is available.

<img alt="Docusaurus with Keytar" src={useBaseUrl('static/img/nim-project-create-ex.png')} />

### Creating a YAML file for your project

**NOTE**: What makes Nimbella standout is that you don't need a YAML file for most simple projects. But if you want to customize specific things you are deploying, you can build a `.yml` file for it.

To generate a `.yml` file when you create a project. Run the command:

```
nim project create folder_name --config
```

The `--config` flag tells the CLI to generate a `.yml` template you can use for your project. You should see this template inside of your project folder:

```
targetNamespace: ''
cleanNamespace: false
bucket: {}
parameters: {}
environment: {}
packages:
- name: default
shared: false
clean: false
environment: {}
parameters: {}
annotations: {}
actions:
- name: hello
clean: false
binary: false
main: ''
runtime: 'nodejs:default'
web: true
webSecure: false
parameters: {}
environment: {}
annotations: {}
limits: {}
```

### Basics of the project structure.

After creating the project folder, you'll see that it contains two folders. A `web` folder to add directories and files with static web content and a `packages` folder to create serverless functions.

[Click here to learn more about the project structure you just created.](https://github.com/nimbella/docs/blob/master/docs/projects.md)
59 changes: 43 additions & 16 deletions sidebars.js
Original file line number Diff line number Diff line change
@@ -1,18 +1,45 @@
module.exports = {
someSidebar: {
"Introduction": ["welcome", "what-is-nimbella", "serverless", "serverless-vs-server", "serveless-apps", "why-nimbella", "account", "features", "openwhisk"],
"Nimbella Project": ["deployer-overview", "projects", "namespaces", "actions", "project", "configuration", "deployer-feature", "single-action", "namespace-to-projects"],
"Serverless SDK": ["key-value-sdk", "file-stores"],
"Runtime & Languages": ["runtime"],
"CLI": ["install", "commands", "flags", "command-summary", "wsk"],
"Workbench": ["workbench"],
"Getting Started": ["getting-started", "building"],
"Developing and Deploying Serverless APIs": ["sample-project-walkthrough"],
"Developing & Deploying Web": ["web", "web-content"],
"Taking your application to production": ["production"],
"Integrations": ["commander", "postman", "netlify"],
"Porting existing applications onto Nimbella": ["heroku", "express", "django", "flask", "lambda", "openwhisk-port"],
Docusaurus: ['doc1', 'doc2', 'doc3'],
Features: ['mdx'],
},
someSidebar: {
Introduction: [
'welcome',
'what-is-nimbella',
'serverless',
'serverless-vs-server',
'serveless-apps',
'why-nimbella',
'account',
'features',
'openwhisk',
],
'Nimbella Project': [
'deployer-overview',
'projects',
'namespaces',
'actions',
'project',
'configuration',
'deployer-feature',
'single-action',
'namespace-to-projects',
],
'Serverless SDK': ['key-value-sdk', 'file-stores'],
'Runtime & Languages': ['runtime'],
CLI: ['install', 'commands', 'flags', 'command-summary', 'wsk'],
Workbench: ['workbench'],
'Getting Started': ['getting-started', 'building', 'nim-creating-project'],
'Developing and Deploying Serverless APIs': ['sample-project-walkthrough'],
'Developing & Deploying Web': ['web', 'web-content'],
'Taking your application to production': ['production'],
Integrations: ['commander', 'postman', 'netlify'],
'Porting existing applications onto Nimbella': [
'heroku',
'express',
'django',
'flask',
'lambda',
'openwhisk-port',
],
Docusaurus: ['doc1', 'doc2', 'doc3'],
Features: ['mdx'],
},
};
Binary file added static/img/7a-nim-project-create.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/kv-store-redis-example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/nim-project-create-ex.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 23547ed

Please sign in to comment.